POST crm/leads/match

Match CRM 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
  • email [ Mandatory , string ]
    Email adress
  • postcode [ Mandatory , int ]
    Post code , length must be 4
  • date_of_birth [ Optional , date ]
    Birthday
  • mobile_phone [ Optional , string ]
    Mobile phone number.
  • 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
  • lead_source [ Mandatory , 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",
      "mobile_phone": "012345678",
      "date_of_birth": "1985-10-07",
      "email": "service@outlook.com",
      "street": "123 Some Street",
      "city": "Some City",
      "state": "Some State",
      "country": "Some Country",
      "postcode": 1234,
      "lead_source": "Web"
    }
}

Response Information

Response body formats

application/json, text/json

Sample: 
Success:
{
  "delivery": "true",
  "receipt": "Found lead."
  "ID": "0032000001Gm555"
  "audit_ID": "1087"
}
Failure:
{
  "delivery": "false",
  "receipt": "Match not found."
  "ID": ""
  "audit_ID": "1087"
]