API Reference

postCustomField

post
https://api.cloudbeds.com/api/v1.3/postCustomField

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

Form Data
string | null

Property ID

string

Field name

string

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

string | null
enum
Defaults to reservation

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

Allowed:
boolean | null
Defaults to false

Specify whether this field is required to be filled out.

integer | null
Defaults to 40

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

string | null
enum
Defaults to input

The field's input type.

Allowed:
displayed
array of strings | null

¹ 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

displayed
boolean

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

Updated 7 months ago

Language
Credentials
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago