v1

latestOpenAPI 3.0.02026-07-26866217.8 KB

Property

Create Tag

Create a new property tag. Optionally pre-attach properties via property_ids and / or room types via room_type_ids. The name must be unique within the operator's account (soft-deleted same-name tags are restored). Color is auto-assigned from the Hostex palette unless one of the allowed hex strings is supplied. Operators are capped at 500 property tags.

post/tags

Request body

namestring required

Tag display name. Max 15 characters. Must be unique within the operator's account.

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

Hex color string. Auto-assigned from the palette when omitted.

property_idsinteger[]

Optional list of property ids to attach to the new tag.

room_type_idsinteger[]

Optional list of room type ids to attach to the new tag.

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."
}