Documentation Index

Fetch the complete documentation index at: https://www.bloxs.io/llms.txt

Use this file to discover all available pages before exploring further.

Delete property definition

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

Delete property definition in the system

Delete property definition

This endpoint deletes an existing custom property definition, identified by its apiLabel.

Integrators call this endpoint to remove a custom field that is no longer needed in the published data.

Unlike other endpoints in this API, apiLabel is passed as a path parameter here (for example /propertydefinitions/location), not as a query parameter.


Request Fields

Field

Type

Required

Description

apiLabel

string

Yes

Unique identifier of the custom property to delete, passed as part of the URL path.


Response Fields

Field

Type

Required

Description

(no response body)

A successful request returns 200 with no response body.

Security
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