Create new property definition in the system
Create new property definition
This endpoint creates a new custom property definition for publishing.
A property definition describes a custom field, such as “Location” or “Accessibility”, those are not natively available in Bloxs but can be added to the data shared with a third-party website.
The apiLabel is chosen by the caller and used to identify this property definition in later update and delete operations.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
apiLabel | string | Yes | Unique identifier to assign to the new custom property. Chosen by the caller; must not already exist. Used to reference this property in later update and delete operations, and as the key of its value in the properties field on published objects. |
labelName | string | Yes | Display name of the custom property. |
controlType | integer | No | Input control type of the custom property. Valid values are 0 (TextBox), 1 (NumberBox), 2 (DateBox), 3 (Dropdown), 4 (RichText), 5 (AmountBox), 6 (SquareMeterBox), or 7 (MultiSelectDropdown). |
order | integer | No | Display order of this property among the other custom properties, both in the Bloxs screen and, if used that way, on the connected website. Not related to the display order of dropdown options; see options.order for that. |
options | array of object | No | Configured options for the property. Applicable when controlType is Dropdown or MultiSelectDropdown. |
options.value | string | Yes | Display text of the dropdown or multi-select option. |
options.order | integer | No | Display order of this option within the dropdown or multi-select list. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
apiLabel | string | Yes | Unique identifier of the created custom property. |
labelName | string | Yes | Display name of the custom property. |
controlType | integer | No | Input control type of the custom property. Valid values are 0 (TextBox), 1 (NumberBox), 2 (DateBox), 3 (Dropdown), 4 (RichText), 5 (AmountBox), 6 (SquareMeterBox), or 7 (MultiSelectDropdown). |
order | integer | No | Display order of this property among the other custom properties. |
options | array of object | No | Configured options for the property. Applicable when controlType is Dropdown or MultiSelectDropdown. |
options.value | string | Yes | Display text of the dropdown or multi-select option. |
options.order | integer | No | Display order of this option within the dropdown or multi-select list. |
The API Key of the property, this is the key used to identify the Object property
The name of the property
The type of the property
When the ControlType is Dropdown, then these are the configured options for the Dropdown
The property definition was added
The API Key of the property, this is the key used to identify the Object property
The name of the property
The type of the property
When the ControlType is Dropdown, then these are the configured options for the Dropdown
The property definition data has validation issues