Create new property definition
- 03 Jan 2025
- 2 Minutes to read
- Print
- DarkLight
Create new property definition
- Updated on 03 Jan 2025
- 2 Minutes to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback!
Post
/api/v1/realestateobjects/publish/propertydefinitions
Create new property definition in the system
Description
The Bloxs user has the possibility to create custom properties which are shown in the published data in the third party system (e.g. rental website). An example would be if the user wants to add to the published data the property 'sunny hours per day'. This is standard not available in Bloxs. To include this in the published data, a custom published property needs to be inserted. This endpoint can be used to add a new custom property. The identifier for a property is the 'apiLabel' and is to be created by the user.
The Bloxs user has the option to create custom properties that are included in the published data sent to third-party systems (e.g., a rental website). For example, if a user wants to add the property "sunny hours per day" to the published data, this is not available by default in Bloxs. To include such a property, a custom published property must be created. This endpoint allows users to add a new custom property. The unique identifier for a property is the apiLabel, which is defined by the user.
Use Case
The Bloxs user wants to add an extra custom property to be displayed in the rental website. This endpoint can be used to add this custom property.
Request fields
The request contains the following fields:
| Field | Description |
|---|---|
| apiLabel | The unique identifier of the custom property. |
| labelName | The name which has been assigned to the custom property. |
| controlType | The control type of the custom property. For example, it can only contain numbers or it is a date field. |
| order | Order in which the fields are displayed within the screen in Bloxs. This can also help arrange the fields in the correct order on your website. |
| options.value | When the ControlType is Dropdown, then these are the configured options for the dropdown. Value contains the name of the option in the dropdown. |
| options.order | When the ControlType is Dropdown, then these are the configured options for the dropdown. Order contains the order in which the option is shown in the dropdown. |
Security
HTTP
Type Bearer
Please enter a valid token
Body parameters
object
apiLabel
string Required
The API Key of the property, this is the key used to identify the Object property
Min length1
labelName
string Required
The name of the property
Min length1
controlType
integer (int32)
0 = TextBox
1 = NumberBox
2 = DateBox
3 = Dropdown
4 = RichText
5 = AmountBox
6 = SquareMeterBox
7 = MultiSelectDropdown
Valid values[ \0\, \1\, \2\, \3\, \4\, \5\, \6\, \7\ ]
order
integer (int32)
options
Array of object (Publish_PropertyDefinitionOption) | null
When the ControlType is Dropdown, then these are the configured options for the Dropdown
object
value
string Required
Min length1
order
integer (int32)
Responses
200
The property definition was added
object
apiLabel
string
The API Key of the property, this is the key used to identify the Object property
Min length1
labelName
string
The name of the property
Min length1
controlType
integer (int32)
0 = TextBox
1 = NumberBox
2 = DateBox
3 = Dropdown
4 = RichText
5 = AmountBox
6 = SquareMeterBox
7 = MultiSelectDropdown
Valid values[ \0\, \1\, \2\, \3\, \4\, \5\, \6\, \7\ ]
order
integer (int32)
options
Array of object (Publish_PropertyDefinitionOption) | null
When the ControlType is Dropdown, then these are the configured options for the Dropdown
object
value
string
Min length1
order
integer (int32)
400
The property definition data has validation issues
object
type
string | null
title
string | null
traceId
string | null
status
integer (int32)
errors
object | null
property*
Array of string | null additionalProperties
string