Skip to content

Aliases to identify object specification

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 as follows or any listed in the section for Braze user profile fields) 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
14
{
  "aliases_to_identify" : (required, array of Aliases to Identify Object)
  [
    {
      "external_id" : (required, string) see External User ID,
      // 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) see User Aliases,
        "alias_label" : (required, string) see User Aliases
      }
    }
  ]
}
WAS THIS PAGE HELPFUL?
New Stuff!