Create a User Identity

Create a new user identity

Creates a new user identity.

/user_identities/create

POSThttps://connect.getseam.com/user_identities/create

Authorization

api_keypat_with_workspaceconsole_session

Body

application/json

user_identity_keynullable string

email_addressnullable string (email)

phone_numbernullable string

full_namenullable string

Response

200400401

OK

Body

application/json

user_identity*user_identity (object)

ok*boolean

Request

JavaScriptCurl

const response = await fetch('https://connect.getseam.com/user_identities/create', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer API Key",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "user_identity": {
    "user_identity_id": "123e4567-e89b-12d3-a456-426614174000",
    "user_identity_key": "text",
    "email_address": "[e-mail]",
    "phone_number": "text",
    "display_name": "text",
    "full_name": "text",
    "created_at": "2024-04-26T16:27:20.046Z",
    "workspace_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "ok": false
}

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": "[e-mail]",
  "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("[e-mail]"),
    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": "[e-mail]",
    "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
}