Update user

Modify user account information including profile details and metadata

PATCH /api/v1/users/

Modifies user account information including profile details, metadata, and external ID. Use this endpoint to update a user’s personal information, contact details, or custom metadata.

Request

Path Parameters

id · string · required

System-generated user ID. Must start with ‘usr_’ and be 19-25 characters long.

usr_123

Query Parameters

external_id · string

Your application’s unique identifier for this user.

ext_12345a67b89c

Body Parameters

user_profile · object

User’s personal information to update.

Show user_profile fields

user_profile.given_name · string

User’s first name. Maximum 255 characters.

user_profile.family_name · string

User’s last name. Maximum 255 characters.

user_profile.name · string

Full display name.

user_profile.phone_number · string

Phone number in E.164 international format.

[phone]

user_profile.locale · string

User’s preferred language and region (BCP-47 format).

en-US

user_profile.picture · string

URL to the user’s profile picture.

user_profile.custom_attributes · object

Custom attributes for extended user profile data. Keys must be 3-25 characters, values must be 1-256 characters.

{
  "department": "engineering",
  "security_clearance": "level2"
}

user_profile.metadata · object

System-managed key-value pairs for internal tracking.

{
  "account_status": "active",
  "signup_source": "mobile_app"
}

user_profile.groups · array

List of group names the user belongs to. Each group name must be 1-250 characters.

["engineering", "managers"]

metadata · object

Custom key-value pairs for storing additional user context.

{
  "department": "sales",
  "location": "nyc-office"
}

Response

user · object

The modified user object with updated timestamps.

Show user object

id · string

Unique system-generated identifier

email · string

Primary email address (immutable)

external_id · string

Your application’s unique identifier

user_profile · object

Updated user’s personal information

memberships · array

List of organization memberships

metadata · object

Updated custom key-value pairs

create_time · string

Timestamp when created (ISO 8601)

update_time · string

Updated timestamp of last modification (ISO 8601)

last_login_time · string

Timestamp of most recent authentication (ISO 8601)

Examples

Error Responses

200 · success

User updated successfully

404 · error

User not found

Notes

• Fields like user ID, email address, environment ID, and creation time cannot be modified
• Only specified fields will be updated; other fields remain unchanged
• The update_time field is automatically updated by the server