POST crm/people/match

Match CRM Contact or Lead.

Request Information

Parameters

NameDescription
json
  • person_data [ Mandatory , object ]
    Matched person's information
  • first_name [ Mandatory , string ]
    First name
  • last_name [ Mandatory , string ]
    Last name
  • date_of_birth [ Mandatory , date ]
    Birthday
  • email [ Mandatory , string ]
    Email adress
  • postcode [ Mandatory , int ]
    Post code , length must be 4
  • mobile_phone [ Optional , string ]
    Mobile phone number
  • drivers_license [ Optional , string ]
    Drivers license id
  • street [ Optional , string ]
    The street you live
  • city [ Optional , string ]
    The city you live
  • state [ Optional , string ]
    The state you live
  • country [ Optional , string ]
    The country you live
  • assets [ Optional , string[] ]
    Assets id
  • lead_source [ Optional , string ]
    Lead source information

Request body formats

application/json, text/json, text/plain, application/x-www-form-urlencoded

Sample: 

{
  "person_data": {
      "first_name": "Josh",
      "last_name": "Smith",
      "date_of_birth": "1985-10-07",
      "email": "service@outlook.com",
      "postcode": 1234,
      "mobile_phone": "012345678",
      "drivers_license": "ABCDEFG",
      "street": "123 Some Street",
      "city": "Some City",
      "state": "Some State",
      "country": "Some Country",
      "assets": [
          "VINFRAME1",
          "VINFRAME2"
       ],
      "lead_source": "Web"
    }
}

Response Information

Response body formats

application/json, text/json

Sample: 
Success:
{
  "delivery": "true",
  "receipt": "Found contact."
  "ID": "0032000001Gm666"
  "audit_ID": "1086"
}
Failure:
{
  "delivery": "false",
  "receipt": "Match not found."
  "ID": ""
  "audit_ID": "1086"
]