Update a User Identity

Updates a specified user identity.

POST /user_identities/update

JavaScript

Seam SDK

await seam.userIdentities.update({
  user_identity_id: "dc378ea9-358e-4999-b295-d0f3e0d5ff51",
  user_identity_key: "jane_doe",
  email_address: "[e-mail]",
  phone_number: "[phone]",
  full_name: "Jane Doe",
});

/*
// void
*/

200

{
  "ok": true
}

Authorizations

pat_with_workspaceconsole_session_with_workspaceapi_key

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

user_identity_id · string<uuid> · required

ID of the user identity that you want to update.

email_address · string<email> | null

Unique email address for the user identity.

full_name · string | null

Full name of the user associated with the user identity.

Minimum string length: 1

phone_number · string | null

Unique phone number for the user identity.

user_identity_key · string | null

Unique key for the user identity.

Minimum string length: 1

Response

200

application/json

OK

ok · boolean · required