Add User Alias

Adds a secondary alias identifier to the current Braze user.

Code Example

braze.getUser().addAlias("guest_abc123", "guest_id");

Event Properties

Property	Type	Constraints	Examples	Description
alias_name	string	required	"guest_abc123" "support_987654"	The alias identifier to attach to the current Braze user.
		minLength: 1
alias_label	string	required	"guest_id" "support_id"	The label that describes the alias source or identifier type.
		minLength: 1

View Raw JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://tracking-docs-demo.buchert.digital/schemas/1.3.0/braze/add-user-alias.json",
  "title": "Add User Alias",
  "description": "Adds a secondary alias identifier to the current Braze user.",
  "x-tracking-targets": [
    "web-braze-js"
  ],
  "x-method": "alias",
  "type": "object",
  "properties": {
    "alias_name": {
      "type": "string",
      "description": "The alias identifier to attach to the current Braze user.",
      "minLength": 1,
      "examples": [
        "guest_abc123",
        "support_987654"
      ]
    },
    "alias_label": {
      "type": "string",
      "description": "The label that describes the alias source or identifier type.",
      "minLength": 1,
      "examples": [
        "guest_id",
        "support_id"
      ]
    }
  },
  "required": [
    "alias_name",
    "alias_label"
  ]
}