Identity

Use the Identity API to manage user identifiers. With this API, you can programmatically add a client user identifier or custom identifier(s) to a user.

Add a client user identifier or custom identifier(s) to a user

Make a call to this endpoint to associate a client user identifier or custom identifier(s) with other identifiers. A client user or custom identifier needs to be accompanied by at least one other identifier of the following types: phone, email, shopify id, klaviyo id, client user identifier, or custom identifier.

Request
Security:
OAuthFlow (identity:write)
Request Body schema: application/json
phone
string

Phone number used to associate a client user identifier or custom identifier(s) with a user. E.164 format is required.

email
string

Email used to associate a client user identifier or custom identifier(s) with a user. There is a 100 character limit.

shopifyId
string

Shopify Id used to associate a client user identifier or custom identifier(s) with a user. There is a 100 character limit.

klaviyoId
string

Klaviyo Id used to associate a client user identifier or custom identifier(s) with a user. There is a 100 character limit.

clientUserId
string

Client user identifier to be associated with a user through a phone, email, shopify id, klaviyo id, or custom identifier. This is a freeform field and can accept any string input. Please do NOT put shopify ids or klaviyo ids here, there are dedicated fields for those identifiers. There is a 100 character limit.

Array of objects (CustomIdentifierDto1)

Custom identifier(s) to be associated with a user through a phone, email, shopify id, klaviyo id, client user identifier, or another custom identifier. There is a 100 character limit.

Responses
202

Request processed.

400

Invalid parameter in request query or body

post/identity-resolution/user-identifiers
Request samples
application/json
{
  • "phone": "+13115552368",
  • "email": "sample-email@attentivemobile.com",
  • "shopifyId": 123456789000,
  • "klaviyoId": "0123456789ABCDEFGHIJKLMNOP",
  • "clientUserId": "123456",
  • "customIdentifiers": [
    ]
}