Attributes

Create a new attribute

post/attribute-tagging/v1/attributes/

Request

  • Base URL
    https://api.cloudbeds.com
  • URL
    https://api.cloudbeds.com/attribute-tagging/v1/attributes/
  • Auth
    HTTP bearer

Headers

x-organization-idstring required

Organization ID

accept-languagestring

Language of a Standard Tag's default name, e.g. de-DE; falls back to en_US

Request body

labelstring required
descriptionstring
entityTypesstring[] required
isEnabledboolean
categoryIdstring nullable

Category this attribute belongs to. Omitted or null means Uncategorized.

positioninteger

Explicit slot within the category. Omitted, the row is appended after the current maximum. Capped at 500000, well below the column's int4 ceiling, so no single write can exhaust the scope's append space.

iconstring nullable

Icon name for this tag, from the Nebula icon set. Null defers to the icon on the category this attribute belongs to, then to the default tag glyph. Not validated against the icon set — an unknown name falls back the same way.

colorstring nullable

Tag colour as a hex string, #RGB or #RRGGBB. Null defers to the colour on the category this attribute belongs to, then to a neutral tile. Stored verbatim, so compare against a preset case-insensitively.

isPinnedboolean

Pins the attribute organization-wide, so it always renders first in a tag row and survives truncation. At most 5 per organization; pinning a sixth answers 409 PIN_LIMIT_EXCEEDED. Pinning an already-pinned attribute is a no-op.

Response

Default Response

labelstring nullable required
namestring required

The name to show: label when the organization set one (never translated), else the Standard Tag's default name in the Content-Language of the response (resolved from Accept-Language, falling back to en_US, then to standardKey).

descriptionstring nullable required
entityTypesstring[] required
isEnabledboolean required
categoryIdstring nullable required
positioninteger required
isPinnedboolean required
iconstring nullable required
colorstring nullable required
standardKey'vip' | 'blacklisted' | 'special_occasion' | 'pet' | 'late_checkout' | 'early_checkin' | 'upgrade' | 'late_arrival' | 'multi_room_reservation' | 'room_move' | 'parking' | 'breakfast' nullable required
isStandardboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.