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 System-generated user ID. Must start with ‘usr_’ and be 19-25 characters long. Query Parameters Your application’s unique identifier for this user. Body Parameters User’s personal information to update. User’s first name. Maximum 255 characters.
User’s last name. Maximum 255 characters.
user_profile.phone_number
Phone number in E.164 international format. User’s preferred language and region (BCP-47 format). URL to the user’s profile picture.
user_profile.custom_attributes
Custom attributes for extended user profile data. Keys must be 3-25 characters, values must be 1-256 characters. { "department" : "engineering" , "security_clearance" : "level2" }
System-managed key-value pairs for internal tracking. { "account_status" : "active" , "signup_source" : "mobile_app" }
List of group names the user belongs to. Each group name must be 1-250 characters. [ "engineering" , "managers" ]
Custom key-value pairs for storing additional user context. { "department" : "sales" , "location" : "nyc-office" }
Response The modified user object with updated timestamps. Unique system-generated identifier
Primary email address (immutable)
Your application’s unique identifier
Updated user’s personal information
List of organization memberships
Updated custom key-value pairs
Timestamp when created (ISO 8601)
Updated timestamp of last modification (ISO 8601)
Timestamp of most recent authentication (ISO 8601)
Examples Error Responses User updated successfully
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