Contents x
    Delete property definition
    • 23 May 2025
    • 1 Minute to read
    • Print
    • Dark
      Light
    Contents

    Delete property definition

    • Updated on 23 May 2025
    • 1 Minute to read
    • Print
    • Dark
      Light
    Article summary

    Delete
    /api/v1/realestateobjects/publish/propertydefinitions/{apiLabel}

    Delete 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 remove one of the currently existing custom properties. The identifier for a property is the 'apiLabel' and is to be created by the user.

    The identifier for a property is the 'apiLabel'. The GET operation can be used to retrieve the apiLabel of the properties.

    Use Case

    The Bloxs user has used the GET operation to retrieve the full list of property definitions. The user decides that one of the property definitions has become obsolete and therefore needs to be removed. With this endpoint the user can delete the custom property.

    Request fields

    The request contains the following field:

    FieldDescription
    apiLabelThe unique identifier of the custom property.
    Security
    HTTP
    Type Bearer

    Please enter a valid token

    Path parameters
    apiLabel
    stringRequired
    Responses
    200

    The property definition was deleted

    400

    The property definition data has validation issues

    Expand All
    object
    type
    string | null
    title
    string | null
    traceId
    string | null
    status
    integer (int32)
    errors
    object | null
    property*
    Array of string | null additionalProperties
    string
    What's Next