POST
/
contact
/
identify
Identify contact
curl --request POST \
  --url https://api.sendx.io/api/v1/rest/contact/identify \
  --header 'Content-Type: application/json' \
  --header 'X-Team-ApiKey: <api-key>' \
  --data '{
  "firstName": "John",
  "lastName": "Doe",
  "email": "user@example.com",
  "newEmail": "user@example.com",
  "company": "Acme Inc.",
  "tags": [
    "new",
    "cool"
  ],
  "customFields": {
    "favorite_color": "blue",
    "favorite_food": "pizza"
  }
}'
{
  "status": "200",
  "message": "OK"
}

The Identify API Method is used to attach data to a visitor and manage contact creation or updates.

​
Example Request:

{
  "email": "john.doe@gmail.com",
  "firstName": "John",
  "lastName": "Doe",
  "birthday": "1989-03-03",
  "customFields": {
    "Designation": "Software Engineer",
    "Age": "27",
    "Experience": "5"
  },
  "tags": ["Developer", "API Team"]
}
  • Tags and custom fields that do not exist are created automatically.
  • Existing tags and custom fields are updated with the new data.
  • Properties are additive: no data is removed based on subsequent Identify calls.

Authorizations

​
X-Team-ApiKey
string
header
required

Body

application/json

Response

200
application/json

Success Response

The response is of type object.