Update User Group
Partially update an existing User Group record — only send the fields you want to change.
Optional fields
Any request field marked nullable in the schema may be omitted
from the payload entirely - you don't need to send it as null. On a
PATCH (partial update), an omitted field is left unchanged; on a POST
it's left unset.
HTTP Request
PATCH/users/api/v1/groups/{id}/
Example Response
{"id": 0,"site": 0,"permissions": [],"created": "2026-09-08T14:40:49.498Z","modified": "2026-09-08T14:40:49.498Z","deleted": "2026-09-08T14:40:49.498Z","uuid": "770bba28-9f80-4d40-9c51-6e022364af91","source_ref": "string","name": "string","active": false,"statistics": 0}
| Name | Description |
|---|---|
id required | integer id of Record |
| Name | Description |
|---|---|
id | integer ID |
site | integer Site |
permissions required | array of integers Choices: [ 1,2,3...2147483648 ] |
created | string Created |
modified | string Modified |
deleted nullable | string Deleted |
uuid | string Uuid |
source_ref nullable | string<= 100 characters Source ref - A unique reference to use for linking records back to *your* system. NB: This must be unique across the entire Prop Data system, so it's best to use a consistent prefix unique to your integration to avoid conflicts with other api consumers. |
name required | string[ 1...100 ] characters Name |
active | boolean Active |
statistics nullable | integer Statistics |
Responses
200
400 Bad request body
403 You do not have permission to perform this action
404 Not found
500 Internal server error
503 This website is not active