v1

latestOpenAPI 3.1.02026-07-244010.8 KB

Identify

This API allows you to identify users given some anonymous user_id from the Heap SDK and some known identity, such as an email address. When this call is made, all events associated with the provided user_id are migrated to the user with the provided identity.<br><br>To protect the integrity of your data, we limit the number of identities mapped to a user_id to 1. We also limit the number of user_ids mapped to an identity to 10, over a one-month period.<br><br>As an example, if you send an identify request for user_id 123 and identity susan, we will drop a subsequent identify call for user_id 123 and identity bill. Likewise, if you send 10 identify calls with 10 different user_ids for identity susan in a one-month period, the 11th user_id for identity susan will be ignored.

post/api/v1/identify

Request body

app_idstring required

The environment ID of your Main Production project.

user_idstring required

The user_id from the Heap SDK. The user_id must be the string representation of a number between zero and 2^53 - 1.

identitystring required

An identity, typically corresponding to an existing user. If no such identity exists, then a new user will be created with that identity. Case-sensitive string, limited to 255 characters.

timestampstring

ISO8601 e.g. "2017-03-10T22:21:56+00:00". Defaults to the current time if not provided.

Response

200

object required