Remove listing

View as Markdown
**Withdraw a property from PropertyPal.** Once deleted, the property no longer appears on PropertyPal and will not be returned by GET endpoints. Any associated space listings are also removed. ### Request body | Field | Description | | --- | --- | | `agentId` | Your branch identifier. Must match the agent the property was created against. | | `removalReason` | One of `SOLD_BY_US`, `SOLD_BY_ANOTHER_AGENT`, `WITHDRAWN_FROM_MARKET`, `LOST_INSTRUCTION`, `LET_BY_US`, `REMOVED`. | ### Response - **`200 OK`** — listing removed. - **`404 Not Found`** — no matching property for the (`reference`, `agentId`) pair.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

referencestringRequired

Request

This endpoint expects an object.
agentIdintegerOptional
removalReasonstringOptional

Response

200 — Removed

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
502
Bad Gateway Error
503
Service Unavailable Error