Update the configured property definition in the system
Update existing property definitions
This endpoint updates an existing custom property definition, identified by its apiLabel.
Integrators call this endpoint to correct or change a custom property's label, control type, order, or dropdown options after retrieving its current definition.
This operation fully overwrites the property definition identified by apiLabel. Any field not included in the request will be cleared, not left unchanged.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
apiLabel | string | Yes | Unique identifier of the custom property to update. Must match an existing property definition. |
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 updated 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 updated
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