Skip to main content
PUT
Update a user

Authorizations

Authorization
string
header
required

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

Path Parameters

organization_id
string
required

Organization identifier.

Required string length: 24
Pattern: ^[0-9a-f]{24}$
user_id
string
required

User ID to update

Required string length: 24
Pattern: ^[0-9a-f]{24}$

Body

application/json
name
string
required

User's name.

Required string length: 1 - 120
surname
string
required

User's surname.

Required string length: 1 - 120
email
string<email>
required

User's email address.

department
string | null
required

User's department.

role_id
string | null
required

Identifier of the role assigned to the user.

Required string length: 24
Pattern: ^[0-9a-f]{24}$

Response

User updated successfully.

id
string
required

User identifier.

Required string length: 24
Pattern: ^[0-9a-f]{24}$
name
string
required

User's name.

surname
string
required

User's surname.

email
string<email>
required

User's email address.

language
enum<string>
required

User's preferred language code.

Available options:
en-EN,
es-ES,
pt-BR,
ca-ES,
eu-ES
created_at
string
required

Creation date in ISO 8601 format.

organization_id
string | null

Organization identifier associated with the user.

Required string length: 24
Pattern: ^[0-9a-f]{24}$
department
string | null

User's department.

role_id
string | null

Identifier of the role assigned to the user.

Required string length: 24
Pattern: ^[0-9a-f]{24}$
created_by
string | null

Identifier of the user who created the user record.

Required string length: 24
Pattern: ^[0-9a-f]{24}$
email_login_enabled
boolean | null

Indicates if email login is enabled for the user.