UsersUsers

Update User

Update a User by ID

Required scope | users:write

The email and password fields cannot be updated using this endpoint

Path parameters

site_idstringRequiredformat: "objectid"

Unique identifier for a Site

user_idstringRequiredformat: "objectid"

Unique identifier for a User

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
dataobjectOptional
accessGroupslist of stringsOptional

An array of access group slugs. Access groups are assigned to the user as type admin and the user remains in the group until removed.

Response

Request was successful

idstringOptionalformat: "objectid"

Unique identifier for the User

isEmailVerifiedbooleanOptional

Shows whether the user has verified their email address

lastUpdatedstringOptionalformat: "date-time"

The timestamp the user was updated

invitedOnstringOptionalformat: "date-time"

The timestamp the user was invited

createdOnstringOptionalformat: "date-time"

The timestamp the user was created

lastLoginstringOptionalformat: "date-time"

The timestamp the user was logged in

statusenumOptional

The status of the user

Allowed values:
accessGroupslist of objectsOptional

Access groups the user belongs to

dataobjectOptional

An object containing the User’s basic info and custom fields

Errors