Identify Profile

POST {{baseUrl}}/identify

This endpoint is used to track and update properties about an individual without tracking an associated event. The following data is stored in a JSON object.

JSON OBJECT STRUCTURE:

token: string This is your public API key.

properties: JSON Object or null Properties of the profile to track/update. You must identify the person by their email using a $email key (or by their phone number using a $phone_number key if you have SMS-only contacts). Other than that, you can include any data you want and it can then be used to create segments of people. For example, if you wanted to create a list of people on trial plans, include a person's plan type in this JSON object so you can use that information later.

SPECIAL FIELDS:

The Klaviyo CRM has the following special fields you can set for customer properties with the Identify endpoint, to unlock additional functionality:

$email: string $first_name: string $last_name: string $phone_number: string; eg: +13239169023 $city: string $region: string; state, or other region $country: string $zip: string $image: string; url to a photo of a person $consent: list of strings; eg: ['sms', 'email', 'web', 'directmail', 'mobile']

EXAMPLE:

  {
      "token": "PUBLIC_KEY",
      "properties": {
        "$email": "abraham.lincoln@klaviyo.com",
        "$first_name": "Abraham",
        "$last_name": "Lincoln",
        "$city": "Springfield",
        "$region": "Illinois"
      }
  }

Request Body

[{"name"=>"data", "value"=>"{\"token\": \"PUBLIC_KEY\",\"properties\": {\"$email\":\"ben.franklin@klaviyo.com\"}}", "datatype"=>"string"}]

HEADERS

RESPONSES

status: OK

1