API Playground - get_custom_property_definition

get_custom_property_definition


Use this function to retrieve details of a custom resource property, a custom user property or a custom site property (metasites only). In case of a custom user property, the output will also include the following fields: default_value, form_item_name (associated reservation form item) (click for full documentation)

name

Custom property name

scope

One of 'resource', 'user', 'site'. Default is 'resource'. This determines whether the custom property definition is for resource properties, user properties or site properties. The value 'site' is used only by metasites.

language

by specifying a 2-letter (ISO 639-1) language code (all capital letters e.g. EN, DE, FR, ES, IT) you can change the language of the text values returned

api_key

* - påkrevd felt