Sign in

v1

latestOpenAPI 3.0.0proprietary2026-07-261695971.5 MB
User

Update a User

Updates a given User. Any parameters not provided are left unchanged.

patch/users/{userId}

Path parameters

userIdstring uuid required

The unique identifier for a resource.

Example:9a93d3b5-fb3b-4abf-9e70-26315b33506c

User Id

Request body

role'admin' | 'member'

New role assigned to the User. It can be member or admin.

activeboolean

If true, the User will be activated; if false, the User will be suspended.

Response

OK

idstring uuid required

Unique identifier of the User.

emailstring email required

Email of the User.

locale'en' | 'fr' | 'de' | 'it' | 'nl' | 'es' | 'pl' | 'pt' | 'ro' required

Locale of the User.

statusstring required

The status of the User. Upon receiving the webhook event, status will always be completed.

is_activeboolean required

Whether the User is active.

role'member' | 'admin' required

User’s role.

Example response

{
  "id": "550e8402-e29b-41d4-a716-446655440000",
  "email": "john.doe@example.com",
  "locale": "fr",
  "status": "completed",
  "is_active": true,
  "role": "member"
}