V2 APIGroups
Update group
PATCH
/api/v2/groups/{group}Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
group*string
Format
uuidQuery Parameters
account_id?string
Optional account to run this request against. Defaults to the account the API token is scoped to, so callers with a single account can omit it. Must be an account the authenticated user belongs to; staff may target any account. For write requests the value may be sent in the JSON body instead of the query string. The resolved account is returned on the X-Resi-Account-Id response header.
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
A group cannot move to another set; sending group_set_id is a 422.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/api/v2/groups/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "group_set_id": "90dcd050-0bc2-4e3a-b042-5b7bebcd5079", "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef", "label": "string", "slug": "string", "description": "string", "color": "string", "sort_order": 0, "children": [ {} ], "group_set": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "key": "string", "property_id": "05003a8a-8f3c-454b-8884-a906ec46f5f5", "object_type": "property", "allows_multiple_membership": true, "groups_count": 0, "groups": [ {} ], "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }}