Create Alias

📘

The $create_alias event payload is only useful for projects using the Original ID Merge system and the Legacy ID Management System; it has no functionality in the Simplified ID Merge system. Please review this section of our documentation for more information.

📘

You can also use the import endpoint: https://api.mixpanel.com/import/

Mixpanel supports adding an alias to a distinct id. An alias is a new value that will be interpreted by Mixpanel as an existing value. That means that you can send messages to Mixpanel using the new value, and Mixpanel will continue to use the old value for calculating funnels and retention reports, or applying updates to user profiles.

Alias Criteria:

960

Required Event Object attributes

Event Object propertyTypeDescription
eventString
required
value must be: $create_alias
propertiesObject
required
properties.distinct_idString
required
A distinct_id to be merged with the alias.
properties.aliasString
required
A new distinct_id to be merged with the original distinct_id. Each alias can only map to one distinct_id.
properties.tokenString
required
The project token.
Language
URL
Click Try It! to start a request and see the response here!