Delete group
Deletes the group, every group nested under it, and their memberships. The grouped records themselves are not deleted.
/api/v2/groups/{group}Deletes the group, every group nested under it, and their memberships. The grouped records themselves are not deleted.
Authorization
bearerAuth In: header
Path Parameters
uuidQuery Parameters
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.
uuidResponse Body
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/api/v2/groups/497f6eca-6276-4993-bfeb-53cbbbba6f08"Update group PATCH
Previous Page
Add group member POST
Adds a property, building, floor plan or unit to the group. The member must match the set's `object_type`, belong to the account (and to the set's property, for a property set), and, in a set that does not allow multiple membership, not already be in another group of the set. A rule broken is a `422`; nothing is moved for you.