Aliases to Identify Object

An API request with any fields in the Attributes Object will create or update an attribute of that name with the given value on the specified user profile. Use Braze User Profile Field names (listed below or any listed in the User Profile Fields chart) to update those special values on the user profile in the dashboard or add your own custom attribute data to the user.

Object Body

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

{
   "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

WAS THIS PAGE HELPFUL?
New Stuff!