Create New User Aliases

POST https://{{instance_url}}/users/alias/new

Use this endpoint to add new user aliases for existing identified users, or to create new unidentified users.

Adding a user alias for an existing user requires an external_id to be included in the new user alias object. If the external_id is present in the object but there is no user with that external_id, the alias will not be added to any users. If an external_id is not present, a user will still be created, but will need to be identified later. You can do this using the Identifying Users and the users/identify endpoint

Creating a new alias-only user requires the external_id to be omitted from the new user alias object. Once the user is created, use the /users/track endpoint to associate the alias-only user with attributes, events and purchases, and the /users/identify endpoint to identify the user with an external_id.

Request Parameters

Request Components

• User Alias Object
  
  For more information on alias_name and alias_label, check out our User Aliases documentation.

Request Body

{"user_aliases"=>[{"external_id"=>"external_identifier", "alias_name"=>"example_name", "alias_label"=>"example_label"}]}

HEADERS