Users
Update User
Update an existing User record.
PUT
Update User
Updates an existing User record. You must include the
Id of the record to update along with all required fields.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the User-Edit role.Enums
eLanguage — Language values
eLanguage — Language values
Request Body
Required Fields
integer
required
The Id of the User record to update.
string
required
The full name value for this user.
string
required
The email value for this user.
integer
required
The language value for this user.
string
required
The password salt value for this user.
integer
required
The last help visited value for this user.
integer
required
The invalid login attempts value for this user.
Optional Fields
string
The access token value for this user.
integer
ID of the preferred language linked to this record.
string
The new password value for this user.
string
The password value for this user.
string
URL of a new file to upload as the avatar.
boolean
Set to true to remove the current avatar file.
integer
ID of the application linked to this record.
boolean
Whether this user is currently active.
boolean
Whether is admin is enabled.
boolean
Whether api access is enabled.
boolean
Whether validated is enabled.
boolean
Whether must reset password is enabled.
string
Date/time value for last access.
string
The devices value for this user.
boolean
Whether on new email is enabled.
boolean
Whether on help desk msg is enabled.
boolean
Whether on new wall post is enabled.
boolean
Whether on new member is enabled.
boolean
Whether on profile changes is enabled.
boolean
Whether on new blog comment is enabled.
boolean
Whether on new event comment is enabled.
boolean
Whether on tariff change is enabled.
boolean
Whether on booking change is enabled.
boolean
Whether on tentative booking change is enabled.
boolean
Whether on purchases is enabled.
boolean
Whether on visitor registration is enabled.
boolean
Whether on plaform invoices is enabled.
boolean
Whether receive community digest is enabled.
boolean
Whether receive every message is enabled.
string
The two factor secret value for this user.
string
Unique identifier (GUID) for the email call back.
integer[]
List of businesses linked to this record.
integer[]
The added businesses value for this user.
integer[]
The removed businesses value for this user.
integer[]
List of user roles linked to this record.
integer[]
The added user roles value for this user.
integer[]
The removed user roles value for this user.
integer[]
List of chat rooms linked to this record.
integer[]
The added chat rooms value for this user.
integer[]
The removed chat rooms value for this user.
string
Date/time value for last received community thread date.
string
Date/time value for last received community message date.
string
Date/time value for next community digest.
string
The support team user email value for this user.
string
Date/time value for last login attempt.
boolean
Whether on access control errors is enabled.
string
Date/time value for next help desk message reminder.
boolean
Whether on member removed from team is enabled.
boolean
Whether on virtual office tariff change is enabled.
boolean
Whether on virtual office delivery preference update is enabled.
boolean
Whether on identity check update is enabled.
Code Examples
Response
200
integer
HTTP status code.
200 on success.string
A human-readable message confirming the update.
object
Contains the
Id of the updated record.boolean
true if the user was updated successfully.array
null on success.Example Response
400
string
A summary of the validation error(s), in the format
PropertyName: error message.any
null on validation failure.object[]
Array of validation errors.
boolean
false when the request fails validation.Example Response
Update User