v1

latestOpenAPI 3.0.32026-07-24235275.4 KB

Identity

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.

post/identity-resolution/user-identifiers

Request body

phonestring

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

emailstring

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

shopifyIdstring

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

klaviyoIdstring

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

clientUserIdstring

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.

Example request

{
  "phone": "+13115552368",
  "email": "sample-email@attentivemobile.com",
  "klaviyoId": "0123456789ABCDEFGHIJKLMNOP",
  "clientUserId": "123456",
  "customIdentifiers": [
    {
      "name": "loyaltyId",
      "value": "1122334455"
    }
  ]
}

Response

Request processed.