CLcloudbeds
CustomFields

postCustomField

Sets custom fields. The call should only be made once to add the field to the system.

post/postCustomField

Request

  • Base URL
    https://api.cloudbeds.com/api/v1.3
  • URL
    https://api.cloudbeds.com/api/v1.3/postCustomField
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization code
      Scopes: write:customFields

Request body application/x-www-form-urlencoded

propertyIDstring nullable

Property ID

namestring

Field name

shortcodestring

Internal reference and is used for integration purposes such as custom links and the API

applyTo'reservation' | 'guest' nullable

Where put this field in reservation or guest section of the booking. reservation - applies the custom field to reservations in myfrontdesk guest - applies the custom field to guest interface in myfrontdesk

requiredboolean nullable

Specify whether this field is required to be filled out.

maxCharactersinteger nullable

Maximum number of characters allowed to be entered in this field.

type'input' | 'text' nullable

The field's input type.

displayedstring[] nullable

¹ Specify where this custom field to show up. reservation - applies the custom field to reservation interface in myfrontdesk booking - applies the custom field to the booking engine card - applies the custom field to Registration cards

isPersonalboolean

Specifies if the contents of this field may contain personal information. User's personal information may be removed upon request according to GDPR rules.

Response

200 Response

successboolean

Returns if the request could be completed

messagestring nullable

To be used in case any error occurs (if success = false). If success = true, it does not exist.

Changes

No recorded changes to this operation across all 2 revisions of this API.