Delete
/api/v1/contracts/conceptprivaterent
Delete an existing concept private rent contract.
Delete a concept private rent contract
This endpoint deletes an existing draft residential lease contract.
This endpoint can only be used before the contract is finalized in the Bloxs application.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
externalIdentifier | string | Yes | Identifier of the concept contract to delete, within the integrating system's own system. Not generated by Bloxs. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
(response body) | boolean | Yes | The response is a single boolean value, not an object with named fields. True indicates the concept contract was deleted. |
Security
Query parameters
externalIdentifier
stringRequired
The external API identifier of the model.
Responses
200
A concept private rent contract was deleted
400
The concept private rent contract 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