Quick Start Guide
Live workflowThis path uses the public documentation and the current Developer Console screens. Production CRM credentials are created from an agent CRM connection; sandbox activity belongs to a developer application.
1. AccountCreate a developer account when you need applications, sandbox logs, API Explorer, simulator runs or sandbox webhook simulation inspection.
2. ApplicationOpen
Developers / Console / Applications and create a sandbox application.3. KeysUse the application credentials for sandbox testing or the agent Generic CRM connection key for production API calls.
4. First CallSend
POST /api/v1/crm/properties with a canonical property object.First Property Upload
{
"request_id": "quick-start-001",
"property": {
"external_ref": "CRM-QS-001",
"department": "sale",
"display_address": "10 Sandbox Street, London",
"postcode": "SW1A 1AA",
"price": 425000,
"beds": 3,
"media_image_00": "https://cdn.example.com/qsb/front.jpg"
}
}First Update
PATCH /api/v1/crm/properties/CRM-QS-001
{
"request_id": "quick-start-price-001",
"property": {
"price": 415000,
"marketing_status": "available"
}
}First Delete / Inactivate
DELETE /api/v1/crm/properties/CRM-QS-001
{
"request_id": "quick-start-delete-001"
}The final behaviour follows the CRM connection policy: delete, withdraw or inactivate.
First Lifecycle Status Push
POST /api/v1/crm/properties/CRM-QS-001/withdraw Headers: X-CRM-Key X-CRM-Timestamp X-CRM-Nonce X-CRM-Signature
Provider events use the same signed API contract as normal property requests.
Console Screens Used
| Screen | Purpose | Link |
|---|---|---|
| Applications | Developer Console workflow for this integration. | Open |
| API Explorer | Developer Console workflow for this integration. | Open |
| CRM Simulator | Generate complete canonical payloads, failures, sandbox webhook simulations and rate-limit traffic. | Open |
| API Logs | Developer Console workflow for this integration. | Open |
| Webhook Simulation Logs | Developer Console workflow for this integration. | Open |
| Usage | Developer Console workflow for this integration. | Open |
| Rate Limits | Developer Console workflow for this integration. | Open |