Create a User Identity

Create a new user identity

Creates a new user identity.

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

ParameterTypeDescription

user_identity_key

String Optional

Unique key for the user identity

email_address

String Optional

Unique email address for the user identity

phone_number

String Optional

Unique phone number for the user identity in E.164 format (for example, +15555550100)

full_name

String Optional

Full name of the user associated with the user identity

Sample Request

curl -X 'POST' \
  'https://connect.getseam.com/user_identities/create' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer ${API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "user_identity_key": "jean_doe",
  "email_address": "jean@example.com",
  "phone_number": "+15555550110",
  "full_name": "Jean Doe"
}'

Response

Returns a user_identity containing the following properties:

PropertyDescription

user_identity_id

ID of the user identity

user_identity_key

Unique key for the user identity

email_address

Unique email address for the user identity

display_name

Display name for the user identity

full_name

Full name of the user associated with the user identity

created_at

Date and time at which the user identity was created

workspace_id

ID of the workspace that contains the user identity

This response also includes a Boolean ok status indicator.

Sample Response

{
  "user_identity": {
    "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
    "user_identity_key": "jean_doe",
    "email_address": "jean@example.com",
    "phone_number": "+15555550110",
    "display_name": "Jean Doe",
    "full_name": "Jean Doe",
    "created_at": "2024-01-11T05:37:50.264Z",
    "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be"
  },
  "ok": true
}

Last updated

Logo

Š Seam Labs, Inc. All rights reserved.