ts.usr.update

Update user attributes (admin only).

Update user attributes (admin only).

Requires authentication

Description

Updates a user’s profile fields. Requires admin privileges. For self-service profile updates, use ts.auth.update_profile instead.

Parameters

NameTypeRequiredDefaultDescription
idstringYesUser ID
namestringNew name
emailstringNew email
statusstringNew status: active, inactive, suspended
langstringLanguage code
timezonestringIANA timezone
email_copybooleanEnable/disable email copies
metadataobjectCustom key-value pairs

Response

Returns the updated user.

{
  "id": "usr_476931df38eb2662...",
  "name": "Updated Agent",
  "status": "active"
}

Errors

CodeDescription
not_authenticatedNo active login for this session
not_foundUser not found
forbiddenAdmin privileges required