v1

latestOpenAPI 3.0.02026-07-26866217.8 KB

Property

Update Group

Update a property group. Pass name to rename it; pass property_ids to replace the group's full property assignment with the supplied list (pass an empty array to detach all properties). Omitted fields are left unchanged.

patch/groups/{id}

Path parameters

idinteger required

Internal group id (from search_property_groups).

Request body

namestring

New display name. Must remain unique within the operator's account.

property_idsinteger[]

Replaces the group's property list with the given ids (each must belong to the operator). Empty array detaches all.

Response

request_idstring required

Unique identifier for the request.

error_codeinteger required

Numeric error code representing the status of the response. A value of 200 indicates success. <br> See the Error Codes section for more information.

error_msgstring required

Message detailing the status of the response.

Example response

{
  "error_msg": "Done."
}