Post-sales

POST/v1/post-sales/bookings/{id}/registration

Record that a booking’s agreement was registered

Access: API key with bookings:write, or a member session. Permission bookings.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

onrequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.statusrequired: "registered"
data.registration_daterequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/post-sales/bookings/{id}/registration' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"on":"2026-10-06"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "registered",
    "registration_date": "2026-10-06"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/post-sales/files

In-flight post-sales files (bookings, resale and rental deals)

Access: API key with deals:read or bookings:read, or a member session. Permission deals.view or bookings.view.

Parameters

kindquery: "new_booking" | "resale" | "rental"
project_idquery: Id
Opaque record id.
unit_idquery: Id
Opaque record id.
owner_idquery: Id
Opaque record id.
stagequery: "token" | "agreement" | "registration" | "handover" | "completed"
stuck_daysquery: integer
loan_requiredquery: "true" | "false"
documents_pendingquery: "true" | "false"
brokerage_duequery: "true" | "false"
include_completedquery: "true" | "false"
qquery: string

Response · 200

datarequired: array of PostSalesFile
metarequired: object
meta.truncatedrequired: boolean

Request

curl -X GET 'https://api.propzolo.com/v1/post-sales/files' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "type": "deal",
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "kind": "new_booking",
      "title": "string",
      "customer": "string",
      "contact_id": "cmusrceel0000q7kaafxqi1om",
      "lead_id": "cmusrceel0000q7kaafxqi1om",
      "project": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "place": "string",
      "agreement_value": 850000000,
      "stage": "token",
      "record_stage": "string",
      "days_in_stage": 0,
      "past_sla": true,
      "progress": 0,
      "next_action": {
        "code": "string",
        "label": "string",
        "count": 0,
        "amount": 850000000
      },
      "owner": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "last_activity_at": "2026-10-06T05:30:00.000Z",
      "loan_required": true,
      "documents": {
        "required": 0,
        "verified": 0,
        "missing": 0,
        "to_verify": 0,
        "rejected": 0
      },
      "dues_outstanding": 850000000,
      "brokerage_due": 850000000,
      "handover_status": "none",
      "open_snags": 0,
      "can_edit": true
    }
  ],
  "meta": {
    "truncated": true
  }
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/post-sales/files/{type}/{id}

One post-sales file

Access: API key with deals:read or bookings:read, or a member session. Permission deals.view or bookings.view.

Parameters

typepathrequired: "deal" | "booking"
idpathrequired: Id
Opaque record id.

Response · 200

datarequired: PostSalesFile
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/post-sales/files/{type}/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "type": "deal",
    "id": "cmusrceel0000q7kaafxqi1om",
    "ref": "string",
    "kind": "new_booking",
    "title": "string",
    "customer": "string",
    "contact_id": "cmusrceel0000q7kaafxqi1om",
    "lead_id": "cmusrceel0000q7kaafxqi1om",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "place": "string",
    "agreement_value": 850000000,
    "stage": "token",
    "record_stage": "string",
    "days_in_stage": 0,
    "past_sla": true,
    "progress": 0,
    "next_action": {
      "code": "string",
      "label": "string",
      "count": 0,
      "amount": 850000000
    },
    "owner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "last_activity_at": "2026-10-06T05:30:00.000Z",
    "loan_required": true,
    "documents": {
      "required": 0,
      "verified": 0,
      "missing": 0,
      "to_verify": 0,
      "rejected": 0
    },
    "dues_outstanding": 850000000,
    "brokerage_due": 850000000,
    "handover_status": "none",
    "open_snags": 0,
    "can_edit": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/post-sales/files/{type}/{id}/checklist

The document checklist of a file

Access: API key with deals:read or bookings:read, or a member session. Permission deals.view or bookings.view.

Parameters

typepathrequired: "deal" | "booking"
idpathrequired: Id
Opaque record id.

Response · 200

datarequired: PostSalesChecklist
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/post-sales/files/{type}/{id}/checklist' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "file": {
      "type": "deal",
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "kind": "new_booking"
    },
    "doc_items": [
      {
        "key": "string",
        "label": "string",
        "required": true,
        "id_kind": "pan",
        "id_number": "string",
        "status": "pending",
        "reject_reason": "string",
        "document": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string",
          "content_type": "string",
          "uploaded_at": "2026-10-06T05:30:00.000Z",
          "applicant_id": "cmusrceel0000q7kaafxqi1om"
        },
        "uploaded_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "uploaded_at": "2026-10-06T05:30:00.000Z",
        "reviewed_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "reviewed_at": "2026-10-06T05:30:00.000Z",
        "reminded_at": "2026-10-06T05:30:00.000Z",
        "in_template": true,
        "personal": true
      }
    ],
    "reminders_enabled": true,
    "applicants": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "is_primary": true
      }
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/post-sales/files/{type}/{id}/checklist/remind

Remind the customer about missing required documents

Access: API key with deals:write or bookings:write, or a member session. Permission deals.edit or bookings.edit.

Parameters

typepathrequired: "deal" | "booking"
idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object or object
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/post-sales/files/{type}/{id}/checklist/remind' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "status": "queued",
    "message_id": "cmusrceel0000q7kaafxqi1om",
    "items": 0
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/post-sales/files/{type}/{id}/checklist/{key}/review

Verify, reject (with a reason) or reset a checklist item

Access: API key with deals:write or bookings:write, or a member session. Permission deals.edit or bookings.edit.

Parameters

typepathrequired: "deal" | "booking"
idpathrequired: Id
Opaque record id.
keypathrequired: string

Request body

actionrequired: "verify" | "reject" | "reset"
reason: string or null

Response · 200

datarequired: PostSalesChecklist
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/post-sales/files/{type}/{id}/checklist/{key}/review' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"action":"verify","reason":"string"}'

Response example

{
  "data": {
    "file": {
      "type": "deal",
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "kind": "new_booking"
    },
    "doc_items": [
      {
        "key": "string",
        "label": "string",
        "required": true,
        "id_kind": "pan",
        "id_number": "string",
        "status": "pending",
        "reject_reason": "string",
        "document": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string",
          "content_type": "string",
          "uploaded_at": "2026-10-06T05:30:00.000Z",
          "applicant_id": "cmusrceel0000q7kaafxqi1om"
        },
        "uploaded_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "uploaded_at": "2026-10-06T05:30:00.000Z",
        "reviewed_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "reviewed_at": "2026-10-06T05:30:00.000Z",
        "reminded_at": "2026-10-06T05:30:00.000Z",
        "in_template": true,
        "personal": true
      }
    ],
    "reminders_enabled": true,
    "applicants": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "is_primary": true
      }
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/post-sales/files/{type}/{id}/checklist/{key}/upload

File an uploaded document against a checklist item

Access: API key with deals:write or bookings:write, or a member session. Permission deals.edit or bookings.edit.

Parameters

typepathrequired: "deal" | "booking"
idpathrequired: Id
Opaque record id.
keypathrequired: string

Request body

filenamerequired: string
content_typerequired: string
sizerequired: integer
keyrequired: string
id_number: string or null
applicant_id: Id or null
A booking’s personal item (income proof, ITR, bank papers, KYC): whose it is; default the primary applicant.

Response · 200

datarequired: PostSalesChecklist
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/post-sales/files/{type}/{id}/checklist/{key}/upload' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"filename":"string","content_type":"string","size":1,"key":"string","id_number":"string","applicant_id":"cmusrceel0000q7kaafxqi1om"}'

Response example

{
  "data": {
    "file": {
      "type": "deal",
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "kind": "new_booking"
    },
    "doc_items": [
      {
        "key": "string",
        "label": "string",
        "required": true,
        "id_kind": "pan",
        "id_number": "string",
        "status": "pending",
        "reject_reason": "string",
        "document": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string",
          "content_type": "string",
          "uploaded_at": "2026-10-06T05:30:00.000Z",
          "applicant_id": "cmusrceel0000q7kaafxqi1om"
        },
        "uploaded_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "uploaded_at": "2026-10-06T05:30:00.000Z",
        "reviewed_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "reviewed_at": "2026-10-06T05:30:00.000Z",
        "reminded_at": "2026-10-06T05:30:00.000Z",
        "in_template": true,
        "personal": true
      }
    ],
    "reminders_enabled": true,
    "applicants": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "is_primary": true
      }
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/post-sales/files/{type}/{id}/handover

The possession / move-in handover of a file

Access: API key with deals:read or bookings:read, or a member session. Permission deals.view or bookings.view.

Parameters

typepathrequired: "deal" | "booking"
idpathrequired: Id
Opaque record id.

Response · 200

datarequired: PostSalesHandover
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/post-sales/files/{type}/{id}/handover' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "file": {
      "type": "deal",
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "kind": "new_booking"
    },
    "status": "open",
    "keys_count": 0,
    "keys_note": "string",
    "meters": {
      "electricity": "string",
      "water": "string",
      "gas": "string"
    },
    "handover_date": "2026-10-06",
    "acceptance_document_id": "cmusrceel0000q7kaafxqi1om",
    "notes": "string",
    "completed_at": "2026-10-06T05:30:00.000Z",
    "completed_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "override_reason": "string",
    "snags": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "description": "string",
        "location": "string",
        "photos": 0,
        "resolved_at": "2026-10-06T05:30:00.000Z",
        "resolved_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "gate": {
      "blockers": [
        "string"
      ],
      "messages": [
        "string"
      ]
    },
    "can_edit": true,
    "can_override": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/post-sales/files/{type}/{id}/handover

Update the handover checklist (keys, meters, day, notes)

Access: API key with deals:write or bookings:write, or a member session. Permission deals.edit or bookings.edit.

Parameters

typepathrequired: "deal" | "booking"
idpathrequired: Id
Opaque record id.

Request body

keys_count: integer or null
keys_note: string or null
meters: object
meters.electricity: string or null
meters.water: string or null
meters.gas: string or null
handover_date: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
notes: string or null

Response · 200

datarequired: PostSalesHandover
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/post-sales/files/{type}/{id}/handover' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"keys_count":0,"keys_note":"string","meters":{"electricity":"string","water":"string","gas":"string"},"handover_date":"2026-10-06","notes":"string"}'

Response example

{
  "data": {
    "file": {
      "type": "deal",
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "kind": "new_booking"
    },
    "status": "open",
    "keys_count": 0,
    "keys_note": "string",
    "meters": {
      "electricity": "string",
      "water": "string",
      "gas": "string"
    },
    "handover_date": "2026-10-06",
    "acceptance_document_id": "cmusrceel0000q7kaafxqi1om",
    "notes": "string",
    "completed_at": "2026-10-06T05:30:00.000Z",
    "completed_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "override_reason": "string",
    "snags": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "description": "string",
        "location": "string",
        "photos": 0,
        "resolved_at": "2026-10-06T05:30:00.000Z",
        "resolved_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "gate": {
      "blockers": [
        "string"
      ],
      "messages": [
        "string"
      ]
    },
    "can_edit": true,
    "can_override": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/post-sales/files/{type}/{id}/handover/acceptance

File the signed possession acceptance / move-in letter

Access: API key with deals:write or bookings:write, or a member session. Permission deals.edit or bookings.edit.

Parameters

typepathrequired: "deal" | "booking"
idpathrequired: Id
Opaque record id.

Request body

filenamerequired: string
content_typerequired: string
sizerequired: integer
keyrequired: string

Response · 200

datarequired: PostSalesHandover
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/post-sales/files/{type}/{id}/handover/acceptance' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"filename":"string","content_type":"string","size":1,"key":"string"}'

Response example

{
  "data": {
    "file": {
      "type": "deal",
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "kind": "new_booking"
    },
    "status": "open",
    "keys_count": 0,
    "keys_note": "string",
    "meters": {
      "electricity": "string",
      "water": "string",
      "gas": "string"
    },
    "handover_date": "2026-10-06",
    "acceptance_document_id": "cmusrceel0000q7kaafxqi1om",
    "notes": "string",
    "completed_at": "2026-10-06T05:30:00.000Z",
    "completed_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "override_reason": "string",
    "snags": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "description": "string",
        "location": "string",
        "photos": 0,
        "resolved_at": "2026-10-06T05:30:00.000Z",
        "resolved_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "gate": {
      "blockers": [
        "string"
      ],
      "messages": [
        "string"
      ]
    },
    "can_edit": true,
    "can_override": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/post-sales/files/{type}/{id}/handover/complete

Complete the handover (a blocked gate needs the override permission and a reason)

Access: API key with deals:write or bookings:write, or a member session. Permission deals.edit or bookings.edit.

Parameters

typepathrequired: "deal" | "booking"
idpathrequired: Id
Opaque record id.

Request body

handover_daterequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
override_reason: string or null

Response · 200

datarequired: PostSalesHandover
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/post-sales/files/{type}/{id}/handover/complete' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"handover_date":"2026-10-06","override_reason":"string"}'

Response example

{
  "data": {
    "file": {
      "type": "deal",
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "kind": "new_booking"
    },
    "status": "open",
    "keys_count": 0,
    "keys_note": "string",
    "meters": {
      "electricity": "string",
      "water": "string",
      "gas": "string"
    },
    "handover_date": "2026-10-06",
    "acceptance_document_id": "cmusrceel0000q7kaafxqi1om",
    "notes": "string",
    "completed_at": "2026-10-06T05:30:00.000Z",
    "completed_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "override_reason": "string",
    "snags": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "description": "string",
        "location": "string",
        "photos": 0,
        "resolved_at": "2026-10-06T05:30:00.000Z",
        "resolved_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "gate": {
      "blockers": [
        "string"
      ],
      "messages": [
        "string"
      ]
    },
    "can_edit": true,
    "can_override": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/post-sales/files/{type}/{id}/handover/snags

Log a snag with photos

Access: API key with deals:write or bookings:write, or a member session. Permission deals.edit or bookings.edit.

Parameters

typepathrequired: "deal" | "booking"
idpathrequired: Id
Opaque record id.

Request body

descriptionrequired: string
location: string or null
photos: array of object
photos[].filenamerequired: string
photos[].content_typerequired: string
photos[].sizerequired: integer
photos[].keyrequired: string

Response · 200

datarequired: PostSalesHandover
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/post-sales/files/{type}/{id}/handover/snags' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"description":"string","location":"string","photos":[{"filename":"string","content_type":"string","size":1,"key":"string"}]}'

Response example

{
  "data": {
    "file": {
      "type": "deal",
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "kind": "new_booking"
    },
    "status": "open",
    "keys_count": 0,
    "keys_note": "string",
    "meters": {
      "electricity": "string",
      "water": "string",
      "gas": "string"
    },
    "handover_date": "2026-10-06",
    "acceptance_document_id": "cmusrceel0000q7kaafxqi1om",
    "notes": "string",
    "completed_at": "2026-10-06T05:30:00.000Z",
    "completed_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "override_reason": "string",
    "snags": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "description": "string",
        "location": "string",
        "photos": 0,
        "resolved_at": "2026-10-06T05:30:00.000Z",
        "resolved_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "gate": {
      "blockers": [
        "string"
      ],
      "messages": [
        "string"
      ]
    },
    "can_edit": true,
    "can_override": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/post-sales/files/{type}/{id}/handover/snags/{snagId}

Resolve or reopen a snag

Access: API key with deals:write or bookings:write, or a member session. Permission deals.edit or bookings.edit.

Parameters

typepathrequired: "deal" | "booking"
idpathrequired: Id
Opaque record id.
snagIdpathrequired: Id
Opaque record id.

Request body

resolvedrequired: boolean

Response · 200

datarequired: PostSalesHandover
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/post-sales/files/{type}/{id}/handover/snags/{snagId}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"resolved":true}'

Response example

{
  "data": {
    "file": {
      "type": "deal",
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "kind": "new_booking"
    },
    "status": "open",
    "keys_count": 0,
    "keys_note": "string",
    "meters": {
      "electricity": "string",
      "water": "string",
      "gas": "string"
    },
    "handover_date": "2026-10-06",
    "acceptance_document_id": "cmusrceel0000q7kaafxqi1om",
    "notes": "string",
    "completed_at": "2026-10-06T05:30:00.000Z",
    "completed_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "override_reason": "string",
    "snags": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "description": "string",
        "location": "string",
        "photos": 0,
        "resolved_at": "2026-10-06T05:30:00.000Z",
        "resolved_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "gate": {
      "blockers": [
        "string"
      ],
      "messages": [
        "string"
      ]
    },
    "can_edit": true,
    "can_override": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/post-sales/files/{type}/{id}/handover/snags/{snagId}/photos/{index}

A 60-second signed URL of a snag photo

Access: API key with deals:read or bookings:read, or a member session. Permission deals.view or bookings.view.

Parameters

typepathrequired: "deal" | "booking"
idpathrequired: Id
Opaque record id.
snagIdpathrequired: Id
Opaque record id.
indexpathrequired: integer

Response · 200

datarequired: object
data.urlrequired: string
data.expires_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/post-sales/files/{type}/{id}/handover/snags/{snagId}/photos/{index}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "url": "string",
    "expires_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/post-sales/files/{type}/{id}/uploads/presign

Presign a private upload for a file (checklist document, acceptance letter, snag photo)

Access: API key with deals:write or bookings:write, or a member session. Permission deals.edit or bookings.edit.

Parameters

typepathrequired: "deal" | "booking"
idpathrequired: Id
Opaque record id.

Request body

filenamerequired: string
content_typerequired: string
sizerequired: integer
item_key: string or null

Response · 200

datarequired: object
data.keyrequired: string
data.urlrequired: string
data.methodrequired: string
data.headersrequired: map of string
data.expires_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.max_bytesrequired: integer
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/post-sales/files/{type}/{id}/uploads/presign' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"filename":"string","content_type":"string","size":1,"item_key":"string"}'

Response example

{
  "data": {
    "key": "string",
    "url": "string",
    "method": "string",
    "headers": {},
    "expires_at": "2026-10-06T05:30:00.000Z",
    "max_bytes": 0
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/settings/post-sales

Post-sales settings: checklist templates, stage SLAs, stage updates

Access: API key with deals:read or bookings:read, or a member session. Permission deals.view or bookings.view or settings.view.

Response · 200

datarequired: PostSalesConfig
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/settings/post-sales' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "settings": {
      "stage_sla_days": {
        "token": 1,
        "agreement": 1,
        "registration": 1,
        "handover": 1
      },
      "stage_messages": {
        "agreement": {
          "enabled": true,
          "channel": "auto"
        },
        "registration": {
          "enabled": true,
          "channel": "auto"
        },
        "handover": {
          "enabled": true,
          "channel": "auto"
        },
        "completed": {
          "enabled": true,
          "channel": "auto"
        }
      },
      "document_reminders": true,
      "escalation_lead_days": 1,
      "auto_raise_brokerage": true
    },
    "templates": {
      "new_booking": [
        {
          "key": "string",
          "label": "string",
          "required": true,
          "id_kind": null,
          "personal": null
        }
      ],
      "resale": [
        {
          "key": "string",
          "label": "string",
          "required": true,
          "id_kind": null,
          "personal": null
        }
      ],
      "rental": [
        {
          "key": "string",
          "label": "string",
          "required": true,
          "id_kind": null,
          "personal": null
        }
      ]
    },
    "defaults": {
      "settings": {
        "stage_sla_days": {
          "token": 1,
          "agreement": 1,
          "registration": 1,
          "handover": 1
        },
        "stage_messages": {
          "agreement": {
            "enabled": true,
            "channel": "auto"
          },
          "registration": {
            "enabled": true,
            "channel": "auto"
          },
          "handover": {
            "enabled": true,
            "channel": "auto"
          },
          "completed": {
            "enabled": true,
            "channel": "auto"
          }
        },
        "document_reminders": true,
        "escalation_lead_days": 1,
        "auto_raise_brokerage": true
      },
      "templates": {
        "new_booking": [
          {
            "key": "string",
            "label": "string",
            "required": true,
            "id_kind": null,
            "personal": null
          }
        ],
        "resale": [
          {
            "key": "string",
            "label": "string",
            "required": true,
            "id_kind": null,
            "personal": null
          }
        ],
        "rental": [
          {
            "key": "string",
            "label": "string",
            "required": true,
            "id_kind": null,
            "personal": null
          }
        ]
      }
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PUT/v1/settings/post-sales

Save the post-sales settings and checklist templates

Access: API key or member session. Permission settings.company.

Request body

settings: object
settings.stage_sla_daysrequired: object
settings.stage_sla_days.tokenrequired: integer
settings.stage_sla_days.agreementrequired: integer
settings.stage_sla_days.registrationrequired: integer
settings.stage_sla_days.handoverrequired: integer
settings.stage_messagesrequired: object
settings.stage_messages.agreementrequired: object
settings.stage_messages.registrationrequired: object
settings.stage_messages.handoverrequired: object
settings.stage_messages.completedrequired: object
settings.document_remindersrequired: boolean
settings.escalation_lead_daysrequired: integer
settings.auto_raise_brokeragerequired: boolean
templates: object
templates.new_bookingrequired: array of object
templates.new_booking[].keyrequired: string
templates.new_booking[].labelrequired: string
templates.new_booking[].required: boolean
templates.new_booking[].id_kind: "pan" | "aadhaar" or null
templates.new_booking[].personal: boolean or null
One applicant’s paper (shared with that applicant only); null: decided by the item.
templates.resalerequired: array of object
templates.resale[].keyrequired: string
templates.resale[].labelrequired: string
templates.resale[].required: boolean
templates.resale[].id_kind: "pan" | "aadhaar" or null
templates.resale[].personal: boolean or null
One applicant’s paper (shared with that applicant only); null: decided by the item.
templates.rentalrequired: array of object
templates.rental[].keyrequired: string
templates.rental[].labelrequired: string
templates.rental[].required: boolean
templates.rental[].id_kind: "pan" | "aadhaar" or null
templates.rental[].personal: boolean or null
One applicant’s paper (shared with that applicant only); null: decided by the item.

Response · 200

datarequired: PostSalesConfig
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/settings/post-sales' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"settings":{"stage_sla_days":{"token":1,"agreement":1,"registration":1,"handover":1},"stage_messages":{"agreement":{"enabled":true,"channel":"auto"},"registration":{"enabled":true,"channel":"auto"},"handover":{"enabled":true,"channel":"auto"},"completed":{"enabled":true,"channel":"auto"}},"document_reminders":true,"escalation_lead_days":1,"auto_raise_brokerage":true},"templates":{"new_booking":[{"key":"string","label":"string","required":true,"id_kind":null,"personal":null}],"resale":[{"key":"string","label":"string","required":true,"id_kind":null,"personal":null}],"rental":[{"key":"string","label":"string","required":true,"id_kind":null,"personal":null}]}}'

Response example

{
  "data": {
    "settings": {
      "stage_sla_days": {
        "token": 1,
        "agreement": 1,
        "registration": 1,
        "handover": 1
      },
      "stage_messages": {
        "agreement": {
          "enabled": true,
          "channel": "auto"
        },
        "registration": {
          "enabled": true,
          "channel": "auto"
        },
        "handover": {
          "enabled": true,
          "channel": "auto"
        },
        "completed": {
          "enabled": true,
          "channel": "auto"
        }
      },
      "document_reminders": true,
      "escalation_lead_days": 1,
      "auto_raise_brokerage": true
    },
    "templates": {
      "new_booking": [
        {
          "key": "string",
          "label": "string",
          "required": true,
          "id_kind": null,
          "personal": null
        }
      ],
      "resale": [
        {
          "key": "string",
          "label": "string",
          "required": true,
          "id_kind": null,
          "personal": null
        }
      ],
      "rental": [
        {
          "key": "string",
          "label": "string",
          "required": true,
          "id_kind": null,
          "personal": null
        }
      ]
    },
    "defaults": {
      "settings": {
        "stage_sla_days": {
          "token": 1,
          "agreement": 1,
          "registration": 1,
          "handover": 1
        },
        "stage_messages": {
          "agreement": {
            "enabled": true,
            "channel": "auto"
          },
          "registration": {
            "enabled": true,
            "channel": "auto"
          },
          "handover": {
            "enabled": true,
            "channel": "auto"
          },
          "completed": {
            "enabled": true,
            "channel": "auto"
          }
        },
        "document_reminders": true,
        "escalation_lead_days": 1,
        "auto_raise_brokerage": true
      },
      "templates": {
        "new_booking": [
          {
            "key": "string",
            "label": "string",
            "required": true,
            "id_kind": null,
            "personal": null
          }
        ],
        "resale": [
          {
            "key": "string",
            "label": "string",
            "required": true,
            "id_kind": null,
            "personal": null
          }
        ],
        "rental": [
          {
            "key": "string",
            "label": "string",
            "required": true,
            "id_kind": null,
            "personal": null
          }
        ]
      }
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PUT/v1/settings/post-sales

Save the post-sales settings and checklist templates

Access: API key or member session. Permission settings.company.

Request body

settings: object
settings.stage_sla_daysrequired: object
settings.stage_sla_days.tokenrequired: integer
settings.stage_sla_days.agreementrequired: integer
settings.stage_sla_days.registrationrequired: integer
settings.stage_sla_days.handoverrequired: integer
settings.stage_messagesrequired: object
settings.stage_messages.agreementrequired: object
settings.stage_messages.registrationrequired: object
settings.stage_messages.handoverrequired: object
settings.stage_messages.completedrequired: object
settings.document_remindersrequired: boolean
settings.escalation_lead_daysrequired: integer
settings.auto_raise_brokeragerequired: boolean
templates: object
templates.new_bookingrequired: array of object
templates.new_booking[].keyrequired: string
templates.new_booking[].labelrequired: string
templates.new_booking[].required: boolean
templates.new_booking[].id_kind: "pan" | "aadhaar" or null
templates.new_booking[].personal: boolean or null
One applicant’s paper (shared with that applicant only); null: decided by the item.
templates.resalerequired: array of object
templates.resale[].keyrequired: string
templates.resale[].labelrequired: string
templates.resale[].required: boolean
templates.resale[].id_kind: "pan" | "aadhaar" or null
templates.resale[].personal: boolean or null
One applicant’s paper (shared with that applicant only); null: decided by the item.
templates.rentalrequired: array of object
templates.rental[].keyrequired: string
templates.rental[].labelrequired: string
templates.rental[].required: boolean
templates.rental[].id_kind: "pan" | "aadhaar" or null
templates.rental[].personal: boolean or null
One applicant’s paper (shared with that applicant only); null: decided by the item.

Response · 200

datarequired: PostSalesConfig
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/settings/post-sales' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"settings":{"stage_sla_days":{"token":1,"agreement":1,"registration":1,"handover":1},"stage_messages":{"agreement":{"enabled":true,"channel":"auto"},"registration":{"enabled":true,"channel":"auto"},"handover":{"enabled":true,"channel":"auto"},"completed":{"enabled":true,"channel":"auto"}},"document_reminders":true,"escalation_lead_days":1,"auto_raise_brokerage":true},"templates":{"new_booking":[{"key":"string","label":"string","required":true,"id_kind":null,"personal":null}],"resale":[{"key":"string","label":"string","required":true,"id_kind":null,"personal":null}],"rental":[{"key":"string","label":"string","required":true,"id_kind":null,"personal":null}]}}'

Response example

{
  "data": {
    "settings": {
      "stage_sla_days": {
        "token": 1,
        "agreement": 1,
        "registration": 1,
        "handover": 1
      },
      "stage_messages": {
        "agreement": {
          "enabled": true,
          "channel": "auto"
        },
        "registration": {
          "enabled": true,
          "channel": "auto"
        },
        "handover": {
          "enabled": true,
          "channel": "auto"
        },
        "completed": {
          "enabled": true,
          "channel": "auto"
        }
      },
      "document_reminders": true,
      "escalation_lead_days": 1,
      "auto_raise_brokerage": true
    },
    "templates": {
      "new_booking": [
        {
          "key": "string",
          "label": "string",
          "required": true,
          "id_kind": null,
          "personal": null
        }
      ],
      "resale": [
        {
          "key": "string",
          "label": "string",
          "required": true,
          "id_kind": null,
          "personal": null
        }
      ],
      "rental": [
        {
          "key": "string",
          "label": "string",
          "required": true,
          "id_kind": null,
          "personal": null
        }
      ]
    },
    "defaults": {
      "settings": {
        "stage_sla_days": {
          "token": 1,
          "agreement": 1,
          "registration": 1,
          "handover": 1
        },
        "stage_messages": {
          "agreement": {
            "enabled": true,
            "channel": "auto"
          },
          "registration": {
            "enabled": true,
            "channel": "auto"
          },
          "handover": {
            "enabled": true,
            "channel": "auto"
          },
          "completed": {
            "enabled": true,
            "channel": "auto"
          }
        },
        "document_reminders": true,
        "escalation_lead_days": 1,
        "auto_raise_brokerage": true
      },
      "templates": {
        "new_booking": [
          {
            "key": "string",
            "label": "string",
            "required": true,
            "id_kind": null,
            "personal": null
          }
        ],
        "resale": [
          {
            "key": "string",
            "label": "string",
            "required": true,
            "id_kind": null,
            "personal": null
          }
        ],
        "rental": [
          {
            "key": "string",
            "label": "string",
            "required": true,
            "id_kind": null,
            "personal": null
          }
        ]
      }
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.