Skip to main content

Update a user

Endpoint URL

PATCH /api/v2/users/:id

Update a user

Provide the user ID and updated fields to change user info and you will receive a 204 success message.

NameTypeRequiredDescriptionExample Value
namestringtrueMaximum character limit: 191 characters."John"
surnamestringtrueMaximum character limit: 191 characters."Doe"
loginstringtrueMaximum character limit: 191 characters."johndoe123"
emailemailtrueIt has to be a valid email format and structure. Maximum character limit: 191 characters. The email has to be unique."john@example.com"
descriptionstringtrueMaximum character limit: 191 characters."A short bio"
timezonestringtrueMaximum character limit: 191 characters."UTC"
localestringtrueMaximum character limit: 191 characters."en-US"
email_notificationsbooleantrueEnable or disable email notifications.true
user_type_idintegertrueID representing the user's type.1
activebooleantrueIndicates if the account is active.true
deactivation_datedatetrueDate when the account was deactivated."2024-01-01"
current_passwordstringtrueMaximum character limit: 191 characters."currentPass123"
passwordstringtrueMaximum character limit: 191 characters."newPass456"
creditsfloattrueAmount of user credits.11

Request