Update a User Identity

• Request Parameters

• Response

Updates a specified user identity.

JavaScript

Updates a specified user identity.

Code

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

Output

// void

cURL

Updates a specified user identity.

Code

curl --include --request POST "https://connect.getseam.com/user_identities/update" \
  --header "Authorization: Bearer $SEAM_API_KEY" \
  --json @- <<EOF
{
  "user_identity_id": "dc378ea9-358e-4999-b295-d0f3e0d5ff51",
  "user_identity_key": "jane_doe",
  "email_address": "[email protected]",
  "phone_number": "[phone]",
  "full_name": "Jane Doe"
}
EOF

Output

{}

Python

Updates a specified user identity.

Code

seam.user_identities.update(
    user_identity_id="dc378ea9-358e-4999-b295-d0f3e0d5ff51",
    user_identity_key="jane_doe",
    email_address="[email protected]",
    phone_number="[phone]",
    full_name="Jane Doe",
)

Output

None

Ruby

Updates a specified user identity.

Code

seam.user_identities.update(
  user_identity_id: "dc378ea9-358e-4999-b295-d0f3e0d5ff51",
  user_identity_key: "jane_doe",
  email_address: "[email protected]",
  phone_number: "[phone]",
  full_name: "Jane Doe",
)

Output

nil

PHP

Updates a specified user identity.

Code

<?php
$seam->user_identities->update(
    user_identity_id: "dc378ea9-358e-4999-b295-d0f3e0d5ff51",
    user_identity_key: "jane_doe",
    email_address: "[email protected]",
    phone_number: "[phone]",
    full_name: "Jane Doe"
);

Output

null

Seam CLI

Updates a specified user identity.

Code

seam user-identities update --user_identity_id "dc378ea9-358e-4999-b295-d0f3e0d5ff51" --user_identity_key "jane_doe" --email_address "[email protected]" --phone_number "[phone]" --full_name "Jane Doe"

Output

{}

Authentication Methods

• API key

• Personal access token Must also include the seam-workspace header in the request.

To learn more, see Authentication.

Request Parameters

user_identity_id String (Required)

ID of the user identity that you want to update.

---

email_address String

Unique email address for the user identity.

---

full_name String

Full name of the user associated with the user identity.

---

phone_number String

Unique phone number for the user identity.

---

user_identity_key String

Unique key for the user identity.

---

Response

void