Set listing status
set_listing_statusStage putting one of YOUR agency's listings online (it goes into approval, as the CRM's Publish button does), taking it offline, or marking it sold. Returns a preview, including any credit cost (a private, unshared listing costs credits to publish), and an action_id; NOTHING changes until you call confirm_action with that id, after the agent has said yes.
Publishing checks what the CRM checks (photos, required details, your agency's listing limit) and the preview says what is missing. Sold is for a sale listing that is online or offline; sale_price is recorded for market statistics unless hide_sale_price is true.
Requires a linked PropertyList account: the change is made in the agent's own name, with their CRM permissions, so an agency API key alone cannot make it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | Yes | ||
| reference | Yes | The listing reference. | |
| sale_price | No | Achieved price in euros, for sold. Optional. | |
| hide_sale_price | No | For sold: do not record the price. Optional. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | Yes | ||
| details | Yes | ||
| summary | Yes | What confirming will do, to show the agent. | |
| action_id | Yes | Pass to confirm_action to make the change, or cancel_action to drop it. | |
| expires_at | Yes | ISO 8601, UTC. After this the preview must be staged again. |