v1

latestOpenAPI 3.0.02026-07-26866217.8 KB

Property

Update Tag

Update a property tag. Pass name and / or color to change the tag itself; pass property_ids and / or room_type_ids to replace the tag's full assignment list. Pass an empty array to detach all properties / all room types. Omitted fields are left unchanged.

patch/tags/{id}

Path parameters

idinteger required

Internal tag id (from search_tags).

Request body

namestring

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

color'#FD587B' | '#1BBFA4' | '#FFA410' | '#F3D432' | '#2CBCFD' | '#7175FA' | '#EF7EDE'

Hex color string from the allowed palette.

property_idsinteger[]

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

room_type_idsinteger[]

Replaces the tag's room type 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."
}