Create a User Identity
Create a new user identity
Creates a new user identity.
/user_identities/create
OK
Request
Specify the characteristics of the new user identity by including the corresponding parameters in the request body. Note that if you specify one or more of the user_identity_key
, email_address
, or phone_number
, each of these values must be unique within your workspace.
Request Body Parameters
Parameter | Type | Description |
---|---|---|
| String Optional | Unique key for the user identity |
| String Optional | Unique email address for the user identity |
| String Optional | Unique phone number for the user identity in E.164 format (for example, |
| String Optional | Full name of the user associated with the user identity |
Sample Request
Response
Returns a user_identity
containing the following properties:
Property | Description |
---|---|
| ID of the user identity |
| Unique key for the user identity |
| Unique email address for the user identity |
| Display name for the user identity |
| Full name of the user associated with the user identity |
| Date and time at which the user identity was created |
| ID of the workspace that contains the user identity |
This response also includes a Boolean ok
status indicator.
Sample Response
Last updated