Update Site User
POST /sites/{site_id}/users/{user_id}
Updates an existing site user.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
site_id |
string | Yes | ID of the site |
user_id |
string | Yes | ID of the user to update |
Request Body
Optional Fields
| Field | Type | Required | Description |
|---|---|---|---|
usergroups |
array of integers | No | The full set of site user group IDs to assign. Omitted groups are removed. |
active |
boolean | No | When set to false the user will be blocked from accessing the site |
role |
string | No | Core site role (user, moderator, or administrator) subject to caller permissions. |
display_name_override |
string | No | Name to display for the user within the site. |
hidden_note |
string | No | Private site note. |
billing_address |
string | No | Billing address for the site user. |
account_number |
string | No | Account number. |
return_data |
boolean | No | Defaults to true. Set false to omit the updated object. |
Response
Success Response (200 OK)
data contains the updated SiteUser object by default. When return_data is false, data is an empty array for a single update.
Error Responses
400 Bad Request: Invalid request or validation error401 Unauthorized: Authentication failed403 Forbidden: User does not have permission to update this site user404 Not Found: User with the specified ID does not exist on this site
See the Site Users API overview for related endpoints and shared data structures.