Create a User Identity

Create a new user identity

Creates a new user identity.

Error while loading OpenAPI operation — Failed to fetch OpenAPI file

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
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, [phone])
full_name	String Optional	Full name of the user associated with the user identity

Sample Request

cURL (bash)

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": "[email protected]",
  "phone_number": "[phone]",
  "full_name": "Jean Doe"
}'

Go

userIdentity, uErr := client.UserIdentities.Create(context.Background(), &useridentities.UserIdentitiesCreateRequest{
    UserIdentityKey: api.String("jenny_lee"),
    EmailAddress: api.String("[email protected]"),
    PhoneNumber: api.String("[phone]"),
    FullName: api.String("Jenny Lee"),
})

if uErr != nil {
    return uErr
}

fmt.Println(userIdentity)
return nil

Response

Returns a user_identity containing the following properties:

Property	Description
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

JSON

{
  "user_identity": {
    "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
    "user_identity_key": "jean_doe",
    "email_address": "[email protected]",
    "phone_number": "[phone]",
    "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
}