Identify Users

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.

Request Body

1
Content-Type: application/json

1
2
3
4
{
   "api_key" : (required, string) see App Group REST API Key,
   "aliases_to_identify" : (required, array of Aliases to Identify Object)
}

Request Body with Aliases to Identify Object

1
2
3
4
5
6
7
8
9
10
11
12
13
14

{
   "api_key" : (required, string) see App Group REST API Key,
   "aliases_to_identify" : (required, array of Aliases to Identify Object)
   {
     "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)
     }
   }
}

For more information on alias_name and alias_label, check out our User Aliases documentation. You can learn more about the Alias to Identify Object here