Identify Users

POST https://{{instance_url}}/users/identify

Use this endpoint to identify an unidentified (alias-only) user.

Identifying a user requires an external_id to be included in the aliases to identify the object. If the external_id is not a valid or known ID, it will simply be added to the aliases user's record, and the user will be considered identified.

Subsequently, you can associate multiple additional user aliases with a single external_id. When these subsequent associations are made, only the push tokens and message history associated with the user alias are retained; any attributes, events or purchases will be orphaned and not available on the identified user. One workaround is to export the aliased user's data before identification using the /users/export/ids endpoint, then re-associate the attributes, events, and purchases with the identified user.

You can add up to 50 user aliases per request.

Parameters

Request Components

• Alias to Identify Object
• User Alias Object
  
  

Aliases to Identify Object Specification

{
  "external_id" : (required, string) see External User ID below,
  // external_ids for users that do not exist will return a non-fatal error. 
  // See Server Responses for details.
  "user_alias" : {
    "alias_name" : (required, string),
    "alias_label" : (required, string)
  }
}

Request Body

{"aliases_to_identify"=>[{"external_id"=>"external_identifier", "user_alias"=>{"alias_name"=>"example_alias", "alias_label"=>"example_label"}}]}

HEADERS