Leads

Leads with requirement, owners, the status sheet, duplicate check, merge and bulk actions.

GET/v1/leads

List leads

Keyset-paginated leads within the caller’s view scope. `filter` takes the shared filter DSL over the lead fields (requirement and contact fields included), `view` a smart-list preset, `q` a name, phone suffix (4+ digits) or reference (L-10234). Sort keys: received_at, created_at, next_follow_up_at, last_activity_at, status_changed_at, number, expected_value, score, probability (- for descending).

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

Parameters

cursorquery: string
Opaque cursor from the previous page (`meta.next_cursor`).
limitquery: integer
Page size, 1–200.
sortquery: string
Comma list of sort keys, "-" prefix for descending, e.g. -received_at.
filterquery: string
Filter tree ({ all | any | not | field/op/value }) as JSON or base64url(JSON).
qquery: string
Free-text search.
viewquery: LeadView
Smart-list presets.

Response · 200

datarequired: array of LeadSummary
metarequired: PageMeta

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "number": 0,
      "ref": "L-10234",
      "lead_type": "buy",
      "temperature": "hot",
      "score": 0,
      "score_probability": 0,
      "probability_band": "high",
      "pipeline_id": "cmusrceel0000q7kaafxqi1om",
      "status": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "key": "string",
        "name": "string",
        "color": "string",
        "category": "open"
      },
      "sub_status": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "key": "string",
        "name": "string"
      },
      "status_changed_at": "2026-10-06T05:30:00.000Z",
      "contact": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "phone": "string",
        "email": "string",
        "city": "string",
        "is_nri": true,
        "country": "string"
      },
      "tags": [
        "string"
      ],
      "flags": [
        "escalate"
      ],
      "owner": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "presales": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "source": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "project_id": "cmusrceel0000q7kaafxqi1om",
      "property_id": "cmusrceel0000q7kaafxqi1om",
      "received_at": "2026-10-06T05:30:00.000Z",
      "last_enquiry_at": "2026-10-06T05:30:00.000Z",
      "next_follow_up_at": "2026-10-06T05:30:00.000Z",
      "last_activity_at": "2026-10-06T05:30:00.000Z",
      "last_contacted_at": "2026-10-06T05:30:00.000Z",
      "enquiry_count": 0,
      "call_attempts": 0,
      "connected_calls": 0,
      "duplicate_kind": "string",
      "duplicate_of_id": "cmusrceel0000q7kaafxqi1om",
      "expected_value": 850000000,
      "requirement": {
        "budget_min": 850000000,
        "budget_max": 850000000,
        "bhk": [
          0
        ],
        "property_types": [
          "apartment"
        ],
        "locality_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ],
        "location_text": "string"
      },
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z"
    }
  ],
  "meta": {
    "next_cursor": "string",
    "has_more": 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.

POST/v1/leads

Create a lead

Manual entry through the same pipeline as every enquiry: a known number follows the duplicate policy (re-enquiry on the open lead, a labelled duplicate, or a reopened lead) — see `outcome`.

Access: API key with leads:write, or a member session. Permission leads.create.

Parameters

Idempotency-Keyheader: string
Unique key (a UUID) per logical request. A retry with the same key and body replays the first response for 24 hours (marked Idempotent-Replayed: true); the same key with another body is a 409.

Request body

contact_id: Id or null
Opaque record id.
contact: object
contact.name: string or null
contact.phonesrequired: array of string or PhoneInput
contact.email: string or null
contact.city: string or null
lead_type: LeadType
pipeline_id: Id or null
Opaque record id.
status_id: Id or null
Opaque record id.
sub_status_id: Id or null
Opaque record id.
requirement: RequirementInput
source_id: Id or null
Opaque record id.
campaign_ref: string or null
sub_source: string or null
utm: map of string
project_id: Id or null
Opaque record id.
property_id: Id or null
Opaque record id.
owner_id: Id or null
Opaque record id.
presales_id: Id or null
Opaque record id.
temperature: Temperature or null
expected_value: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
message: string or null
received_at: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
tags: array of string
custom: map of any
duplicate_mode: "policy" | "new_lead"
`policy` (default): a known person follows the duplicate policy; `new_lead`: always a new lead.

Response · 201

datarequired: CreateLeadResult
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/leads' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"contact_id":"cmusrceel0000q7kaafxqi1om","contact":{"name":"string","phones":["string"],"email":"string","city":"string"},"lead_type":"buy","pipeline_id":"cmusrceel0000q7kaafxqi1om","status_id":"cmusrceel0000q7kaafxqi1om","sub_status_id":"cmusrceel0000q7kaafxqi1om","requirement":{"category":"residential","property_types":["apartment"],"bhk":[0],"budget_min":0,"budget_max":0,"area_min_sqft":0,"area_max_sqft":0,"area_unit_display":"sqft","locality_ids":["cmusrceel0000q7kaafxqi1om"],"location_text":"string","possession":"string","transaction_types":["new_booking"],"furnishing":["unfurnished"],"facing":["north"],"floor_preference":"string","min_bathrooms":0,"parking_required":true,"amenity_ids":["cmusrceel0000q7kaafxqi1om"],"vastu_required":true,"purpose":"string","loan_required":true,"loan_status":"string","buy_within":"string","move_in_by":"string","lease_months":0,"tenant_profile":"string","family_size":0,"has_pets":true,"notes":"string"},"source_id":"cmusrceel0000q7kaafxqi1om","campaign_ref":"string","sub_source":"string","utm":{},"project_id":"cmusrceel0000q7kaafxqi1om","property_id":"cmusrceel0000q7kaafxqi1om","owner_id":"cmusrceel0000q7kaafxqi1om","presales_id":"cmusrceel0000q7kaafxqi1om","temperature":"hot","expected_value":0,"message":"string","received_at":"2026-10-06T05:30:00.000Z","tags":["string"],"custom":{},"duplicate_mode":"policy"}'

Response example

{
  "data": {
    "outcome": "created",
    "lead_id": "cmusrceel0000q7kaafxqi1om",
    "contact_id": "cmusrceel0000q7kaafxqi1om",
    "duplicate_of_id": "cmusrceel0000q7kaafxqi1om",
    "needs_assignment": true,
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "number": 0,
      "ref": "L-10234",
      "lead_type": "buy",
      "temperature": "hot",
      "score": 0,
      "score_probability": 0,
      "probability_band": "high",
      "pipeline_id": "cmusrceel0000q7kaafxqi1om",
      "status": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "key": "string",
        "name": "string",
        "color": "string",
        "category": "open"
      },
      "sub_status": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "key": "string",
        "name": "string"
      },
      "status_changed_at": "2026-10-06T05:30:00.000Z",
      "contact": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "phone": "string",
        "email": "string",
        "city": "string",
        "is_nri": true,
        "country": "string",
        "phones": [
          "string"
        ],
        "phone_details": [
          {
            "id": "cmusrceel0000q7kaafxqi1om",
            "label": "string",
            "is_primary": true,
            "is_whatsapp": true,
            "country": "string"
          }
        ],
        "alternate_email": "string",
        "kinds": [
          "string"
        ],
        "language": "string",
        "dnd": true,
        "blocked": true
      },
      "tags": [
        "string"
      ],
      "flags": [
        "escalate"
      ],
      "owner": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "presales": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "source": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "project_id": "cmusrceel0000q7kaafxqi1om",
      "property_id": "cmusrceel0000q7kaafxqi1om",
      "received_at": "2026-10-06T05:30:00.000Z",
      "last_enquiry_at": "2026-10-06T05:30:00.000Z",
      "next_follow_up_at": "2026-10-06T05:30:00.000Z",
      "last_activity_at": "2026-10-06T05:30:00.000Z",
      "last_contacted_at": "2026-10-06T05:30:00.000Z",
      "enquiry_count": 0,
      "call_attempts": 0,
      "connected_calls": 0,
      "duplicate_kind": "string",
      "duplicate_of_id": "cmusrceel0000q7kaafxqi1om",
      "expected_value": 850000000,
      "requirement": {
        "category": "residential",
        "property_types": [
          "apartment"
        ],
        "bhk": [
          0
        ],
        "budget_min": 850000000,
        "budget_max": 850000000,
        "area_min_sqft": 0,
        "area_max_sqft": 0,
        "area_unit_display": "sqft",
        "locality_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ],
        "location_text": "string",
        "possession": "string",
        "transaction_types": [
          "new_booking"
        ],
        "furnishing": [
          "unfurnished"
        ],
        "facing": [
          "north"
        ],
        "floor_preference": "string",
        "min_bathrooms": 0,
        "parking_required": true,
        "amenity_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ],
        "vastu_required": true,
        "purpose": "string",
        "loan_required": true,
        "loan_status": "string",
        "buy_within": "string",
        "move_in_by": "2026-10-06",
        "lease_months": 0,
        "tenant_profile": "string",
        "family_size": 0,
        "has_pets": true,
        "notes": "string"
      },
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z",
      "pipeline": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "sub_source": "string",
      "utm": {},
      "campaign_id": "cmusrceel0000q7kaafxqi1om",
      "team_id": "cmusrceel0000q7kaafxqi1om",
      "branch_id": "cmusrceel0000q7kaafxqi1om",
      "partner_id": "cmusrceel0000q7kaafxqi1om",
      "partner_tag_expires_at": "2026-10-06T05:30:00.000Z",
      "assigned_at": "2026-10-06T05:30:00.000Z",
      "assigned_via": "string",
      "rotation_count": 0,
      "expected_close_on": "2026-10-06",
      "first_response_at": "2026-10-06T05:30:00.000Z",
      "site_visits_done": 0,
      "won_at": "2026-10-06T05:30:00.000Z",
      "lost_at": "2026-10-06T05:30:00.000Z",
      "lost_note": "string",
      "phone_verified": true,
      "ai_handled": true,
      "score_reasons": null,
      "custom": {},
      "open_tasks": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "type": "string",
          "title": "string",
          "due_at": "2026-10-06T05:30:00.000Z",
          "assignee_id": "cmusrceel0000q7kaafxqi1om",
          "is_system": true
        }
      ],
      "enquiries": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "source": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "name": "string"
          },
          "sub_source": "string",
          "campaign_ref": "string",
          "message": "string",
          "is_reenquiry": true,
          "received_at": "2026-10-06T05:30:00.000Z"
        }
      ],
      "permissions": {
        "can_edit": true,
        "can_assign": true,
        "can_delete": 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.
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/leads/bulk

Bulk actions on leads

Selected ids, or "all matching" a filter / view / search — always within your scope, at most 10,000 leads. Assign (one member or a round-robin split), status (only statuses that ask for no details), tags (on the contacts), delete (soft).

Access: Signed-in members only (web or Android session) — not for API keys. Permission leads.bulk.

Request body

ids: array of Id
Opaque record id.
filter: FilterNode
PropZolo filter: { all: [...] } | { any: [...] } | { not: … } | { field, op, value }
view: LeadView
Smart-list presets.
q: string
all: boolean
Every lead in scope (with no filter).
actionrequired: object or object or object or object
request_approval: object or null
Ask for approval when a policy requires it: the chain is raised and returned in meta.approval.
request_approval.note: string or null

Response · 200

datarequired: BulkLeadsResult
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/leads/bulk' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"ids":["cmusrceel0000q7kaafxqi1om"],"filter":null,"view":"all","q":"string","all":true,"action":{"action":"assign","role":"owner","owner_id":"cmusrceel0000q7kaafxqi1om","member_ids":["cmusrceel0000q7kaafxqi1om"]},"request_approval":{"note":"string"}}'

Response example

{
  "data": {
    "action": "assign",
    "matched": 0,
    "updated": 0,
    "skipped": [
      {
        "id": "string",
        "reason": "string"
      }
    ]
  },
  "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.

GET/v1/leads/deleted

Recycle bin

Soft-deleted leads that can be restored (deleted by a person — one lead or a bulk delete), within the caller’s `leads.delete` scope, newest deletion first. Merged-away leads, erased people and import rollbacks are final and never listed. `filter` takes the lead filter DSL (deleted_at, deleted_by_id included).

Access: API key or member session. Permission leads.delete.

Parameters

cursorquery: string
Opaque cursor from the previous page (`meta.next_cursor`).
limitquery: integer
Page size, 1–200.
sortquery: string
Comma list of sort keys, "-" prefix for descending, e.g. -received_at.
filterquery: string
Filter tree ({ all | any | not | field/op/value }) as JSON or base64url(JSON).
qquery: string
Free-text search.

Response · 200

datarequired: array of DeletedLead
metarequired: PageMeta

Request

curl -X GET 'https://api.propzolo.com/v1/leads/deleted' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "number": 0,
      "ref": "L-10234",
      "lead_type": "buy",
      "temperature": "hot",
      "score": 0,
      "score_probability": 0,
      "probability_band": "high",
      "pipeline_id": "cmusrceel0000q7kaafxqi1om",
      "status": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "key": "string",
        "name": "string",
        "color": "string",
        "category": "open"
      },
      "sub_status": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "key": "string",
        "name": "string"
      },
      "status_changed_at": "2026-10-06T05:30:00.000Z",
      "contact": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "phone": "string",
        "email": "string",
        "city": "string",
        "is_nri": true,
        "country": "string"
      },
      "tags": [
        "string"
      ],
      "flags": [
        "escalate"
      ],
      "owner": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "presales": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "source": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "project_id": "cmusrceel0000q7kaafxqi1om",
      "property_id": "cmusrceel0000q7kaafxqi1om",
      "received_at": "2026-10-06T05:30:00.000Z",
      "last_enquiry_at": "2026-10-06T05:30:00.000Z",
      "next_follow_up_at": "2026-10-06T05:30:00.000Z",
      "last_activity_at": "2026-10-06T05:30:00.000Z",
      "last_contacted_at": "2026-10-06T05:30:00.000Z",
      "enquiry_count": 0,
      "call_attempts": 0,
      "connected_calls": 0,
      "duplicate_kind": "string",
      "duplicate_of_id": "cmusrceel0000q7kaafxqi1om",
      "expected_value": 850000000,
      "requirement": {
        "budget_min": 850000000,
        "budget_max": 850000000,
        "bhk": [
          0
        ],
        "property_types": [
          "apartment"
        ],
        "locality_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ],
        "location_text": "string"
      },
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z",
      "deleted_at": "2026-10-06T05:30:00.000Z",
      "deleted_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "delete_reason": "manual"
    }
  ],
  "meta": {
    "next_cursor": "string",
    "has_more": 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/leads/duplicates

Live duplicate check

Who already has this number or email, and their leads (records outside your scope carry no id).

Access: Signed-in members only (web or Android session) — not for API keys. Permission leads.create.

Parameters

phonequery: string
emailquery: string

Response · 200

datarequired: LeadDuplicateCheck
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/leads/duplicates' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "match": "phone",
    "contact": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "phone": "string",
      "email": "string"
    },
    "leads": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "lead_type": "string",
        "status": {
          "name": "string",
          "category": "string",
          "color": "string"
        },
        "owner": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "received_at": "2026-10-06T05:30:00.000Z",
        "visible": 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.
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/leads/merge

Merge two leads

Explicit merge (never automatic): enquiries, timeline, tasks, calls and visits move to the kept lead; the merged lead stays as a soft-deleted record labelled `merged`. Needs leads.merge, leads.edit on both and leads.delete on the merged one.

Access: Signed-in members only (web or Android session) — not for API keys. Permission leads.merge.

Request body

winner_idrequired: Id
Opaque record id.
loser_idrequired: Id
Opaque record id.
take_from_loser: array of "owner" | "presales" | "source" | "requirement" | "temperature" | "expected_value" | …
note: string or null

Response · 200

datarequired: MergeLeadsResult
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/leads/merge' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"winner_id":"cmusrceel0000q7kaafxqi1om","loser_id":"cmusrceel0000q7kaafxqi1om","take_from_loser":["owner"],"note":"string"}'

Response example

{
  "data": {
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "number": 0,
      "ref": "L-10234",
      "lead_type": "buy",
      "temperature": "hot",
      "score": 0,
      "score_probability": 0,
      "probability_band": "high",
      "pipeline_id": "cmusrceel0000q7kaafxqi1om",
      "status": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "key": "string",
        "name": "string",
        "color": "string",
        "category": "open"
      },
      "sub_status": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "key": "string",
        "name": "string"
      },
      "status_changed_at": "2026-10-06T05:30:00.000Z",
      "contact": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "phone": "string",
        "email": "string",
        "city": "string",
        "is_nri": true,
        "country": "string",
        "phones": [
          "string"
        ],
        "phone_details": [
          {
            "id": "cmusrceel0000q7kaafxqi1om",
            "label": "string",
            "is_primary": true,
            "is_whatsapp": true,
            "country": "string"
          }
        ],
        "alternate_email": "string",
        "kinds": [
          "string"
        ],
        "language": "string",
        "dnd": true,
        "blocked": true
      },
      "tags": [
        "string"
      ],
      "flags": [
        "escalate"
      ],
      "owner": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "presales": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "source": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "project_id": "cmusrceel0000q7kaafxqi1om",
      "property_id": "cmusrceel0000q7kaafxqi1om",
      "received_at": "2026-10-06T05:30:00.000Z",
      "last_enquiry_at": "2026-10-06T05:30:00.000Z",
      "next_follow_up_at": "2026-10-06T05:30:00.000Z",
      "last_activity_at": "2026-10-06T05:30:00.000Z",
      "last_contacted_at": "2026-10-06T05:30:00.000Z",
      "enquiry_count": 0,
      "call_attempts": 0,
      "connected_calls": 0,
      "duplicate_kind": "string",
      "duplicate_of_id": "cmusrceel0000q7kaafxqi1om",
      "expected_value": 850000000,
      "requirement": {
        "category": "residential",
        "property_types": [
          "apartment"
        ],
        "bhk": [
          0
        ],
        "budget_min": 850000000,
        "budget_max": 850000000,
        "area_min_sqft": 0,
        "area_max_sqft": 0,
        "area_unit_display": "sqft",
        "locality_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ],
        "location_text": "string",
        "possession": "string",
        "transaction_types": [
          "new_booking"
        ],
        "furnishing": [
          "unfurnished"
        ],
        "facing": [
          "north"
        ],
        "floor_preference": "string",
        "min_bathrooms": 0,
        "parking_required": true,
        "amenity_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ],
        "vastu_required": true,
        "purpose": "string",
        "loan_required": true,
        "loan_status": "string",
        "buy_within": "string",
        "move_in_by": "2026-10-06",
        "lease_months": 0,
        "tenant_profile": "string",
        "family_size": 0,
        "has_pets": true,
        "notes": "string"
      },
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z",
      "pipeline": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "sub_source": "string",
      "utm": {},
      "campaign_id": "cmusrceel0000q7kaafxqi1om",
      "team_id": "cmusrceel0000q7kaafxqi1om",
      "branch_id": "cmusrceel0000q7kaafxqi1om",
      "partner_id": "cmusrceel0000q7kaafxqi1om",
      "partner_tag_expires_at": "2026-10-06T05:30:00.000Z",
      "assigned_at": "2026-10-06T05:30:00.000Z",
      "assigned_via": "string",
      "rotation_count": 0,
      "expected_close_on": "2026-10-06",
      "first_response_at": "2026-10-06T05:30:00.000Z",
      "site_visits_done": 0,
      "won_at": "2026-10-06T05:30:00.000Z",
      "lost_at": "2026-10-06T05:30:00.000Z",
      "lost_note": "string",
      "phone_verified": true,
      "ai_handled": true,
      "score_reasons": null,
      "custom": {},
      "open_tasks": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "type": "string",
          "title": "string",
          "due_at": "2026-10-06T05:30:00.000Z",
          "assignee_id": "cmusrceel0000q7kaafxqi1om",
          "is_system": true
        }
      ],
      "enquiries": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "source": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "name": "string"
          },
          "sub_source": "string",
          "campaign_ref": "string",
          "message": "string",
          "is_reenquiry": true,
          "received_at": "2026-10-06T05:30:00.000Z"
        }
      ],
      "permissions": {
        "can_edit": true,
        "can_assign": true,
        "can_delete": true
      }
    },
    "moved": {
      "enquiries": 0,
      "activities": 0,
      "tasks": 0,
      "calls": 0,
      "visits": 0,
      "conversations": 0,
      "other": 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.
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/leads/restore

Restore leads from the recycle bin

Brings leads back (audited, `lead.restored` per lead). Ids outside the caller’s recycle bin are returned in `not_found`. Tasks cancelled by the delete stay cancelled.

Access: Signed-in members only (web or Android session) — not for API keys. Permission leads.delete.

Request body

idsrequired: array of Id
Opaque record id.

Response · 200

datarequired: object
data.restoredrequired: array of Id
Opaque record id.
data.labelledrequired: array of object
data.labelled[].idrequired: Id
Opaque record id.
data.labelled[].duplicate_of_idrequired: Id
Opaque record id.
data.not_foundrequired: array of Id
Opaque record id.
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/leads/restore' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"ids":["cmusrceel0000q7kaafxqi1om"]}'

Response example

{
  "data": {
    "restored": [
      "cmusrceel0000q7kaafxqi1om"
    ],
    "labelled": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "duplicate_of_id": "cmusrceel0000q7kaafxqi1om"
      }
    ],
    "not_found": [
      "cmusrceel0000q7kaafxqi1om"
    ]
  },
  "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.

GET/v1/leads/{id}

A lead

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: LeadDetail
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "number": 0,
    "ref": "L-10234",
    "lead_type": "buy",
    "temperature": "hot",
    "score": 0,
    "score_probability": 0,
    "probability_band": "high",
    "pipeline_id": "cmusrceel0000q7kaafxqi1om",
    "status": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "key": "string",
      "name": "string",
      "color": "string",
      "category": "open"
    },
    "sub_status": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "key": "string",
      "name": "string"
    },
    "status_changed_at": "2026-10-06T05:30:00.000Z",
    "contact": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "phone": "string",
      "email": "string",
      "city": "string",
      "is_nri": true,
      "country": "string",
      "phones": [
        "string"
      ],
      "phone_details": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "label": "string",
          "is_primary": true,
          "is_whatsapp": true,
          "country": "string"
        }
      ],
      "alternate_email": "string",
      "kinds": [
        "string"
      ],
      "language": "string",
      "dnd": true,
      "blocked": true
    },
    "tags": [
      "string"
    ],
    "flags": [
      "escalate"
    ],
    "owner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "presales": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "source": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "project_id": "cmusrceel0000q7kaafxqi1om",
    "property_id": "cmusrceel0000q7kaafxqi1om",
    "received_at": "2026-10-06T05:30:00.000Z",
    "last_enquiry_at": "2026-10-06T05:30:00.000Z",
    "next_follow_up_at": "2026-10-06T05:30:00.000Z",
    "last_activity_at": "2026-10-06T05:30:00.000Z",
    "last_contacted_at": "2026-10-06T05:30:00.000Z",
    "enquiry_count": 0,
    "call_attempts": 0,
    "connected_calls": 0,
    "duplicate_kind": "string",
    "duplicate_of_id": "cmusrceel0000q7kaafxqi1om",
    "expected_value": 850000000,
    "requirement": {
      "category": "residential",
      "property_types": [
        "apartment"
      ],
      "bhk": [
        0
      ],
      "budget_min": 850000000,
      "budget_max": 850000000,
      "area_min_sqft": 0,
      "area_max_sqft": 0,
      "area_unit_display": "sqft",
      "locality_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "location_text": "string",
      "possession": "string",
      "transaction_types": [
        "new_booking"
      ],
      "furnishing": [
        "unfurnished"
      ],
      "facing": [
        "north"
      ],
      "floor_preference": "string",
      "min_bathrooms": 0,
      "parking_required": true,
      "amenity_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "vastu_required": true,
      "purpose": "string",
      "loan_required": true,
      "loan_status": "string",
      "buy_within": "string",
      "move_in_by": "2026-10-06",
      "lease_months": 0,
      "tenant_profile": "string",
      "family_size": 0,
      "has_pets": true,
      "notes": "string"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "pipeline": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "sub_source": "string",
    "utm": {},
    "campaign_id": "cmusrceel0000q7kaafxqi1om",
    "team_id": "cmusrceel0000q7kaafxqi1om",
    "branch_id": "cmusrceel0000q7kaafxqi1om",
    "partner_id": "cmusrceel0000q7kaafxqi1om",
    "partner_tag_expires_at": "2026-10-06T05:30:00.000Z",
    "assigned_at": "2026-10-06T05:30:00.000Z",
    "assigned_via": "string",
    "rotation_count": 0,
    "expected_close_on": "2026-10-06",
    "first_response_at": "2026-10-06T05:30:00.000Z",
    "site_visits_done": 0,
    "won_at": "2026-10-06T05:30:00.000Z",
    "lost_at": "2026-10-06T05:30:00.000Z",
    "lost_note": "string",
    "phone_verified": true,
    "ai_handled": true,
    "score_reasons": null,
    "custom": {},
    "open_tasks": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "type": "string",
        "title": "string",
        "due_at": "2026-10-06T05:30:00.000Z",
        "assignee_id": "cmusrceel0000q7kaafxqi1om",
        "is_system": true
      }
    ],
    "enquiries": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "source": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "sub_source": "string",
        "campaign_ref": "string",
        "message": "string",
        "is_reenquiry": true,
        "received_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "permissions": {
      "can_edit": true,
      "can_assign": true,
      "can_delete": 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/leads/{id}

Update a lead

`requirement` and `custom` are partial: only the keys sent change. Send an `Idempotency-Key` to make a retry (the mobile offline queue) safe.

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

Parameters

idpathrequired: Id
Opaque record id.
Idempotency-Keyheader: string
Unique key (a UUID) per logical request. A retry with the same key and body replays the first response for 24 hours (marked Idempotent-Replayed: true); the same key with another body is a 409.

Request body

lead_type: LeadType
temperature: Temperature or null
source_id: Id or null
Opaque record id.
campaign_id: Id or null
Opaque record id.
sub_source: string or null
utm: map of string or null
project_id: Id or null
Opaque record id.
property_id: Id or null
Opaque record id.
expected_value: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
expected_close_on: string or null
requirement: RequirementInput
custom: map of any

Response · 200

datarequired: LeadDetail
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/leads/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"lead_type":"buy","temperature":"hot","source_id":"cmusrceel0000q7kaafxqi1om","campaign_id":"cmusrceel0000q7kaafxqi1om","sub_source":"string","utm":{},"project_id":"cmusrceel0000q7kaafxqi1om","property_id":"cmusrceel0000q7kaafxqi1om","expected_value":0,"expected_close_on":"string","requirement":{"category":"residential","property_types":["apartment"],"bhk":[0],"budget_min":0,"budget_max":0,"area_min_sqft":0,"area_max_sqft":0,"area_unit_display":"sqft","locality_ids":["cmusrceel0000q7kaafxqi1om"],"location_text":"string","possession":"string","transaction_types":["new_booking"],"furnishing":["unfurnished"],"facing":["north"],"floor_preference":"string","min_bathrooms":0,"parking_required":true,"amenity_ids":["cmusrceel0000q7kaafxqi1om"],"vastu_required":true,"purpose":"string","loan_required":true,"loan_status":"string","buy_within":"string","move_in_by":"string","lease_months":0,"tenant_profile":"string","family_size":0,"has_pets":true,"notes":"string"},"custom":{}}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "number": 0,
    "ref": "L-10234",
    "lead_type": "buy",
    "temperature": "hot",
    "score": 0,
    "score_probability": 0,
    "probability_band": "high",
    "pipeline_id": "cmusrceel0000q7kaafxqi1om",
    "status": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "key": "string",
      "name": "string",
      "color": "string",
      "category": "open"
    },
    "sub_status": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "key": "string",
      "name": "string"
    },
    "status_changed_at": "2026-10-06T05:30:00.000Z",
    "contact": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "phone": "string",
      "email": "string",
      "city": "string",
      "is_nri": true,
      "country": "string",
      "phones": [
        "string"
      ],
      "phone_details": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "label": "string",
          "is_primary": true,
          "is_whatsapp": true,
          "country": "string"
        }
      ],
      "alternate_email": "string",
      "kinds": [
        "string"
      ],
      "language": "string",
      "dnd": true,
      "blocked": true
    },
    "tags": [
      "string"
    ],
    "flags": [
      "escalate"
    ],
    "owner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "presales": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "source": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "project_id": "cmusrceel0000q7kaafxqi1om",
    "property_id": "cmusrceel0000q7kaafxqi1om",
    "received_at": "2026-10-06T05:30:00.000Z",
    "last_enquiry_at": "2026-10-06T05:30:00.000Z",
    "next_follow_up_at": "2026-10-06T05:30:00.000Z",
    "last_activity_at": "2026-10-06T05:30:00.000Z",
    "last_contacted_at": "2026-10-06T05:30:00.000Z",
    "enquiry_count": 0,
    "call_attempts": 0,
    "connected_calls": 0,
    "duplicate_kind": "string",
    "duplicate_of_id": "cmusrceel0000q7kaafxqi1om",
    "expected_value": 850000000,
    "requirement": {
      "category": "residential",
      "property_types": [
        "apartment"
      ],
      "bhk": [
        0
      ],
      "budget_min": 850000000,
      "budget_max": 850000000,
      "area_min_sqft": 0,
      "area_max_sqft": 0,
      "area_unit_display": "sqft",
      "locality_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "location_text": "string",
      "possession": "string",
      "transaction_types": [
        "new_booking"
      ],
      "furnishing": [
        "unfurnished"
      ],
      "facing": [
        "north"
      ],
      "floor_preference": "string",
      "min_bathrooms": 0,
      "parking_required": true,
      "amenity_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "vastu_required": true,
      "purpose": "string",
      "loan_required": true,
      "loan_status": "string",
      "buy_within": "string",
      "move_in_by": "2026-10-06",
      "lease_months": 0,
      "tenant_profile": "string",
      "family_size": 0,
      "has_pets": true,
      "notes": "string"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "pipeline": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "sub_source": "string",
    "utm": {},
    "campaign_id": "cmusrceel0000q7kaafxqi1om",
    "team_id": "cmusrceel0000q7kaafxqi1om",
    "branch_id": "cmusrceel0000q7kaafxqi1om",
    "partner_id": "cmusrceel0000q7kaafxqi1om",
    "partner_tag_expires_at": "2026-10-06T05:30:00.000Z",
    "assigned_at": "2026-10-06T05:30:00.000Z",
    "assigned_via": "string",
    "rotation_count": 0,
    "expected_close_on": "2026-10-06",
    "first_response_at": "2026-10-06T05:30:00.000Z",
    "site_visits_done": 0,
    "won_at": "2026-10-06T05:30:00.000Z",
    "lost_at": "2026-10-06T05:30:00.000Z",
    "lost_note": "string",
    "phone_verified": true,
    "ai_handled": true,
    "score_reasons": null,
    "custom": {},
    "open_tasks": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "type": "string",
        "title": "string",
        "due_at": "2026-10-06T05:30:00.000Z",
        "assignee_id": "cmusrceel0000q7kaafxqi1om",
        "is_system": true
      }
    ],
    "enquiries": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "source": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "sub_source": "string",
        "campaign_ref": "string",
        "message": "string",
        "is_reenquiry": true,
        "received_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "permissions": {
      "can_edit": true,
      "can_assign": true,
      "can_delete": 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.

DELETE/v1/leads/{id}

Delete a lead

Soft delete (recoverable, audited); open tasks of the lead are cancelled. When the company’s delete policy asks for approval: 409 approval_required, or — with `request_approval=1` — the chain in meta.approval (deleted false).

Access: Signed-in members only (web or Android session) — not for API keys. Permission leads.delete.

Parameters

idpathrequired: Id
Opaque record id.
request_approvalquery: "1" | "true"
approval_notequery: string

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.deletedrequired: boolean
metarequired: object

Request

curl -X DELETE 'https://api.propzolo.com/v1/leads/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "deleted": 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/leads/{id}/assign

Assign a lead

Closing owner and / or pre-sales owner; open tasks follow the lead to its new owner.

Access: API key with leads:write, or a member session. Permission leads.assign.

Parameters

idpathrequired: Id
Opaque record id.

Request body

owner_id: Id or null
Closing owner; null unassigns.
presales_id: Id or null
Opaque record id.
reason: string or null

Response · 200

datarequired: LeadDetail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/leads/{id}/assign' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"owner_id":"cmusrceel0000q7kaafxqi1om","presales_id":"cmusrceel0000q7kaafxqi1om","reason":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "number": 0,
    "ref": "L-10234",
    "lead_type": "buy",
    "temperature": "hot",
    "score": 0,
    "score_probability": 0,
    "probability_band": "high",
    "pipeline_id": "cmusrceel0000q7kaafxqi1om",
    "status": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "key": "string",
      "name": "string",
      "color": "string",
      "category": "open"
    },
    "sub_status": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "key": "string",
      "name": "string"
    },
    "status_changed_at": "2026-10-06T05:30:00.000Z",
    "contact": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "phone": "string",
      "email": "string",
      "city": "string",
      "is_nri": true,
      "country": "string",
      "phones": [
        "string"
      ],
      "phone_details": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "label": "string",
          "is_primary": true,
          "is_whatsapp": true,
          "country": "string"
        }
      ],
      "alternate_email": "string",
      "kinds": [
        "string"
      ],
      "language": "string",
      "dnd": true,
      "blocked": true
    },
    "tags": [
      "string"
    ],
    "flags": [
      "escalate"
    ],
    "owner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "presales": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "source": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "project_id": "cmusrceel0000q7kaafxqi1om",
    "property_id": "cmusrceel0000q7kaafxqi1om",
    "received_at": "2026-10-06T05:30:00.000Z",
    "last_enquiry_at": "2026-10-06T05:30:00.000Z",
    "next_follow_up_at": "2026-10-06T05:30:00.000Z",
    "last_activity_at": "2026-10-06T05:30:00.000Z",
    "last_contacted_at": "2026-10-06T05:30:00.000Z",
    "enquiry_count": 0,
    "call_attempts": 0,
    "connected_calls": 0,
    "duplicate_kind": "string",
    "duplicate_of_id": "cmusrceel0000q7kaafxqi1om",
    "expected_value": 850000000,
    "requirement": {
      "category": "residential",
      "property_types": [
        "apartment"
      ],
      "bhk": [
        0
      ],
      "budget_min": 850000000,
      "budget_max": 850000000,
      "area_min_sqft": 0,
      "area_max_sqft": 0,
      "area_unit_display": "sqft",
      "locality_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "location_text": "string",
      "possession": "string",
      "transaction_types": [
        "new_booking"
      ],
      "furnishing": [
        "unfurnished"
      ],
      "facing": [
        "north"
      ],
      "floor_preference": "string",
      "min_bathrooms": 0,
      "parking_required": true,
      "amenity_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "vastu_required": true,
      "purpose": "string",
      "loan_required": true,
      "loan_status": "string",
      "buy_within": "string",
      "move_in_by": "2026-10-06",
      "lease_months": 0,
      "tenant_profile": "string",
      "family_size": 0,
      "has_pets": true,
      "notes": "string"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "pipeline": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "sub_source": "string",
    "utm": {},
    "campaign_id": "cmusrceel0000q7kaafxqi1om",
    "team_id": "cmusrceel0000q7kaafxqi1om",
    "branch_id": "cmusrceel0000q7kaafxqi1om",
    "partner_id": "cmusrceel0000q7kaafxqi1om",
    "partner_tag_expires_at": "2026-10-06T05:30:00.000Z",
    "assigned_at": "2026-10-06T05:30:00.000Z",
    "assigned_via": "string",
    "rotation_count": 0,
    "expected_close_on": "2026-10-06",
    "first_response_at": "2026-10-06T05:30:00.000Z",
    "site_visits_done": 0,
    "won_at": "2026-10-06T05:30:00.000Z",
    "lost_at": "2026-10-06T05:30:00.000Z",
    "lost_note": "string",
    "phone_verified": true,
    "ai_handled": true,
    "score_reasons": null,
    "custom": {},
    "open_tasks": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "type": "string",
        "title": "string",
        "due_at": "2026-10-06T05:30:00.000Z",
        "assignee_id": "cmusrceel0000q7kaafxqi1om",
        "is_system": true
      }
    ],
    "enquiries": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "source": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "sub_source": "string",
        "campaign_ref": "string",
        "message": "string",
        "is_reenquiry": true,
        "received_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "permissions": {
      "can_edit": true,
      "can_assign": true,
      "can_delete": 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/leads/{id}/enquiries

Every enquiry of a lead

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: array of LeadEnquiry
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/leads/{id}/enquiries' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "source": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "sub_source": "string",
      "campaign_ref": "string",
      "utm": null,
      "project_id": "cmusrceel0000q7kaafxqi1om",
      "property_id": "cmusrceel0000q7kaafxqi1om",
      "message": "string",
      "is_reenquiry": true,
      "received_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.

GET/v1/leads/{id}/flags

The lead’s quick flags and co-agent

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: LeadFlags
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/leads/{id}/flags' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "lead_id": "cmusrceel0000q7kaafxqi1om",
    "flags": [
      "escalate"
    ],
    "secondary_owner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "can_flag": true,
    "can_assign": 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/leads/{id}/flags

Turn a quick flag on or off

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

flagrequired: "escalate" | "about_to_convert" | "highlight"
onrequired: boolean

Response · 200

datarequired: LeadFlags
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/leads/{id}/flags' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"flag":"escalate","on":true}'

Response example

{
  "data": {
    "lead_id": "cmusrceel0000q7kaafxqi1om",
    "flags": [
      "escalate"
    ],
    "secondary_owner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "can_flag": true,
    "can_assign": 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.

PUT/v1/leads/{id}/secondary-owner

Set or clear the lead’s co-agent

Access: API key with leads:write, or a member session. Permission leads.assign.

Parameters

idpathrequired: Id
Opaque record id.

Request body

member_idrequired: Id or null
Opaque record id.

Response · 200

datarequired: LeadFlags
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/leads/{id}/secondary-owner' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"member_id":"cmusrceel0000q7kaafxqi1om"}'

Response example

{
  "data": {
    "lead_id": "cmusrceel0000q7kaafxqi1om",
    "flags": [
      "escalate"
    ],
    "secondary_owner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "can_flag": true,
    "can_assign": 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/leads/{id}/status

Change a lead’s status

The status sheet: the target status / sub-status decides what is required (follow-up time, visit slot, note, deal, named fields — 422 names the missing input). Creates the follow-up (or the sub-status’s automatic retry on working hours), links your latest call, records the time spent in the previous status. A replay with the same `Idempotency-Key` returns the first answer instead of changing the status twice.

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

Parameters

idpathrequired: Id
Opaque record id.
Idempotency-Keyheader: string
Unique key (a UUID) per logical request. A retry with the same key and body replays the first response for 24 hours (marked Idempotent-Replayed: true); the same key with another body is a 409.

Request body

status_idrequired: Id
Opaque record id.
sub_status_id: Id or null
Opaque record id.
follow_up_at: ZonedDateTimeInput or null
ISO 8601 instant, or a local YYYY-MM-DDTHH:mm read in the company time zone.
follow_up_preset: FollowUpPreset or null
note: string or null
visit: object or null
visit.scheduled_atrequired: ZonedDateTimeInput
ISO 8601 instant, or a local YYYY-MM-DDTHH:mm read in the company time zone.
visit.project_id: Id or null
Opaque record id.
visit.property_ids: array of Id
Opaque record id.
visit.unit_ids: array of Id
Opaque record id.
visit.meeting_point: string or null
lost_reason: string or null
deal: map of any or null
fields: map of any
Values the status requires (requirement fields, language, amount …) and custom fields.
call_id: Id or null
Opaque record id.
override_guard: object or null
Override the process guard (F-04): needs the override permission; audited with the reason.
override_guard.reasonrequired: string
request_approval: object or null
Ask for approval when a policy requires it: the chain is raised and returned in meta.approval.
request_approval.note: string or null

Response · 200

datarequired: ChangeLeadStatusResult
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/leads/{id}/status' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"status_id":"cmusrceel0000q7kaafxqi1om","sub_status_id":"cmusrceel0000q7kaafxqi1om","follow_up_at":"2026-10-04T10:00","follow_up_preset":"in_1h","note":"string","visit":{"scheduled_at":"2026-10-04T10:00","project_id":"cmusrceel0000q7kaafxqi1om","property_ids":["cmusrceel0000q7kaafxqi1om"],"unit_ids":["cmusrceel0000q7kaafxqi1om"],"meeting_point":"string"},"lost_reason":"string","deal":{},"fields":{},"call_id":"cmusrceel0000q7kaafxqi1om","override_guard":{"reason":"string"},"request_approval":{"note":"string"}}'

Response example

{
  "data": {
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "number": 0,
      "ref": "L-10234",
      "lead_type": "buy",
      "temperature": "hot",
      "score": 0,
      "score_probability": 0,
      "probability_band": "high",
      "pipeline_id": "cmusrceel0000q7kaafxqi1om",
      "status": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "key": "string",
        "name": "string",
        "color": "string",
        "category": "open"
      },
      "sub_status": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "key": "string",
        "name": "string"
      },
      "status_changed_at": "2026-10-06T05:30:00.000Z",
      "contact": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "phone": "string",
        "email": "string",
        "city": "string",
        "is_nri": true,
        "country": "string",
        "phones": [
          "string"
        ],
        "phone_details": [
          {
            "id": "cmusrceel0000q7kaafxqi1om",
            "label": "string",
            "is_primary": true,
            "is_whatsapp": true,
            "country": "string"
          }
        ],
        "alternate_email": "string",
        "kinds": [
          "string"
        ],
        "language": "string",
        "dnd": true,
        "blocked": true
      },
      "tags": [
        "string"
      ],
      "flags": [
        "escalate"
      ],
      "owner": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "presales": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "source": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "project_id": "cmusrceel0000q7kaafxqi1om",
      "property_id": "cmusrceel0000q7kaafxqi1om",
      "received_at": "2026-10-06T05:30:00.000Z",
      "last_enquiry_at": "2026-10-06T05:30:00.000Z",
      "next_follow_up_at": "2026-10-06T05:30:00.000Z",
      "last_activity_at": "2026-10-06T05:30:00.000Z",
      "last_contacted_at": "2026-10-06T05:30:00.000Z",
      "enquiry_count": 0,
      "call_attempts": 0,
      "connected_calls": 0,
      "duplicate_kind": "string",
      "duplicate_of_id": "cmusrceel0000q7kaafxqi1om",
      "expected_value": 850000000,
      "requirement": {
        "category": "residential",
        "property_types": [
          "apartment"
        ],
        "bhk": [
          0
        ],
        "budget_min": 850000000,
        "budget_max": 850000000,
        "area_min_sqft": 0,
        "area_max_sqft": 0,
        "area_unit_display": "sqft",
        "locality_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ],
        "location_text": "string",
        "possession": "string",
        "transaction_types": [
          "new_booking"
        ],
        "furnishing": [
          "unfurnished"
        ],
        "facing": [
          "north"
        ],
        "floor_preference": "string",
        "min_bathrooms": 0,
        "parking_required": true,
        "amenity_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ],
        "vastu_required": true,
        "purpose": "string",
        "loan_required": true,
        "loan_status": "string",
        "buy_within": "string",
        "move_in_by": "2026-10-06",
        "lease_months": 0,
        "tenant_profile": "string",
        "family_size": 0,
        "has_pets": true,
        "notes": "string"
      },
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z",
      "pipeline": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "sub_source": "string",
      "utm": {},
      "campaign_id": "cmusrceel0000q7kaafxqi1om",
      "team_id": "cmusrceel0000q7kaafxqi1om",
      "branch_id": "cmusrceel0000q7kaafxqi1om",
      "partner_id": "cmusrceel0000q7kaafxqi1om",
      "partner_tag_expires_at": "2026-10-06T05:30:00.000Z",
      "assigned_at": "2026-10-06T05:30:00.000Z",
      "assigned_via": "string",
      "rotation_count": 0,
      "expected_close_on": "2026-10-06",
      "first_response_at": "2026-10-06T05:30:00.000Z",
      "site_visits_done": 0,
      "won_at": "2026-10-06T05:30:00.000Z",
      "lost_at": "2026-10-06T05:30:00.000Z",
      "lost_note": "string",
      "phone_verified": true,
      "ai_handled": true,
      "score_reasons": null,
      "custom": {},
      "open_tasks": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "type": "string",
          "title": "string",
          "due_at": "2026-10-06T05:30:00.000Z",
          "assignee_id": "cmusrceel0000q7kaafxqi1om",
          "is_system": true
        }
      ],
      "enquiries": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "source": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "name": "string"
          },
          "sub_source": "string",
          "campaign_ref": "string",
          "message": "string",
          "is_reenquiry": true,
          "received_at": "2026-10-06T05:30:00.000Z"
        }
      ],
      "permissions": {
        "can_edit": true,
        "can_assign": true,
        "can_delete": true
      }
    },
    "task_ids": [
      "cmusrceel0000q7kaafxqi1om"
    ],
    "visit_id": "cmusrceel0000q7kaafxqi1om",
    "call_id": "cmusrceel0000q7kaafxqi1om",
    "deal_id": "cmusrceel0000q7kaafxqi1om",
    "deal_existing": true,
    "marked_unreachable": 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/settings/duplicate-policy

Duplicate policy

How repeat enquiries from known people are handled; unset keys show the defaults. `version` is sent back on PATCH.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.lead_routing or settings.view.

Response · 200

datarequired: object
data.match_byrequired: "lead_type" | "lead_type_and_project"
data.open_leadrequired: "attach" | "new_labelled"
data.wonrequired: "new_labelled" | "attach"
data.lostrequired: "reopen" | "new_labelled" | "attach"
data.invalidrequired: "reopen" | "new_labelled" | "attach"
data.reopen_within_daysrequired: integer or null
data.no_reopen_sub_status_keysrequired: array of string
data.reopen_torequired: object
data.reopen_to.status_keyrequired: string
data.reopen_to.sub_status_keyrequired: string or null
data.sticky_ownerrequired: boolean
data.sticky_within_daysrequired: integer or null
data.versionrequired: string (date-time) or null
metarequired: object

Request

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

Response example

{
  "data": {
    "match_by": "lead_type",
    "open_lead": "attach",
    "won": "new_labelled",
    "lost": "reopen",
    "invalid": "reopen",
    "reopen_within_days": 1,
    "no_reopen_sub_status_keys": [
      "string"
    ],
    "reopen_to": {
      "status_key": "string",
      "sub_status_key": "string"
    },
    "sticky_owner": true,
    "sticky_within_days": 1,
    "version": "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.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/settings/duplicate-policy

Change the duplicate policy

Changes the given keys; the rest stay as they are. Send the `version` from the last read: 409 CONFLICT when the policy changed since. Only keys that differ from the defaults are stored.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.lead_routing.

Request body

match_by: "lead_type" | "lead_type_and_project"
open_lead: "attach" | "new_labelled"
won: "new_labelled" | "attach"
lost: "reopen" | "new_labelled" | "attach"
invalid: "reopen" | "new_labelled" | "attach"
reopen_within_days: integer or null
sticky_owner: boolean
sticky_within_days: integer or null
versionrequired: string (date-time) or null

Response · 200

datarequired: object
data.match_byrequired: "lead_type" | "lead_type_and_project"
data.open_leadrequired: "attach" | "new_labelled"
data.wonrequired: "new_labelled" | "attach"
data.lostrequired: "reopen" | "new_labelled" | "attach"
data.invalidrequired: "reopen" | "new_labelled" | "attach"
data.reopen_within_daysrequired: integer or null
data.no_reopen_sub_status_keysrequired: array of string
data.reopen_torequired: object
data.reopen_to.status_keyrequired: string
data.reopen_to.sub_status_keyrequired: string or null
data.sticky_ownerrequired: boolean
data.sticky_within_daysrequired: integer or null
data.versionrequired: string (date-time) or null
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/settings/duplicate-policy' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"match_by":"lead_type","open_lead":"attach","won":"new_labelled","lost":"reopen","invalid":"reopen","reopen_within_days":1,"sticky_owner":true,"sticky_within_days":1,"version":"2026-10-06T05:30:00.000Z"}'

Response example

{
  "data": {
    "match_by": "lead_type",
    "open_lead": "attach",
    "won": "new_labelled",
    "lost": "reopen",
    "invalid": "reopen",
    "reopen_within_days": 1,
    "no_reopen_sub_status_keys": [
      "string"
    ],
    "reopen_to": {
      "status_key": "string",
      "sub_status_key": "string"
    },
    "sticky_owner": true,
    "sticky_within_days": 1,
    "version": "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.
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/leads

Create a lead

Manual entry through the same pipeline as every enquiry: a known number follows the duplicate policy (re-enquiry on the open lead, a labelled duplicate, or a reopened lead) — see `outcome`.

Access: API key with leads:write, or a member session. Permission leads.create.

Parameters

Idempotency-Keyheader: string
Unique key (a UUID) per logical request. A retry with the same key and body replays the first response for 24 hours (marked Idempotent-Replayed: true); the same key with another body is a 409.

Request body

contact_id: Id or null
Opaque record id.
contact: object
contact.name: string or null
contact.phonesrequired: array of string or PhoneInput
contact.email: string or null
contact.city: string or null
lead_type: LeadType
pipeline_id: Id or null
Opaque record id.
status_id: Id or null
Opaque record id.
sub_status_id: Id or null
Opaque record id.
requirement: RequirementInput
source_id: Id or null
Opaque record id.
campaign_ref: string or null
sub_source: string or null
utm: map of string
project_id: Id or null
Opaque record id.
property_id: Id or null
Opaque record id.
owner_id: Id or null
Opaque record id.
presales_id: Id or null
Opaque record id.
temperature: Temperature or null
expected_value: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
message: string or null
received_at: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
tags: array of string
custom: map of any
duplicate_mode: "policy" | "new_lead"
`policy` (default): a known person follows the duplicate policy; `new_lead`: always a new lead.

Response · 201

datarequired: CreateLeadResult
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/leads' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"contact_id":"cmusrceel0000q7kaafxqi1om","contact":{"name":"string","phones":["string"],"email":"string","city":"string"},"lead_type":"buy","pipeline_id":"cmusrceel0000q7kaafxqi1om","status_id":"cmusrceel0000q7kaafxqi1om","sub_status_id":"cmusrceel0000q7kaafxqi1om","requirement":{"category":"residential","property_types":["apartment"],"bhk":[0],"budget_min":0,"budget_max":0,"area_min_sqft":0,"area_max_sqft":0,"area_unit_display":"sqft","locality_ids":["cmusrceel0000q7kaafxqi1om"],"location_text":"string","possession":"string","transaction_types":["new_booking"],"furnishing":["unfurnished"],"facing":["north"],"floor_preference":"string","min_bathrooms":0,"parking_required":true,"amenity_ids":["cmusrceel0000q7kaafxqi1om"],"vastu_required":true,"purpose":"string","loan_required":true,"loan_status":"string","buy_within":"string","move_in_by":"string","lease_months":0,"tenant_profile":"string","family_size":0,"has_pets":true,"notes":"string"},"source_id":"cmusrceel0000q7kaafxqi1om","campaign_ref":"string","sub_source":"string","utm":{},"project_id":"cmusrceel0000q7kaafxqi1om","property_id":"cmusrceel0000q7kaafxqi1om","owner_id":"cmusrceel0000q7kaafxqi1om","presales_id":"cmusrceel0000q7kaafxqi1om","temperature":"hot","expected_value":0,"message":"string","received_at":"2026-10-06T05:30:00.000Z","tags":["string"],"custom":{},"duplicate_mode":"policy"}'

Response example

{
  "data": {
    "outcome": "created",
    "lead_id": "cmusrceel0000q7kaafxqi1om",
    "contact_id": "cmusrceel0000q7kaafxqi1om",
    "duplicate_of_id": "cmusrceel0000q7kaafxqi1om",
    "needs_assignment": true,
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "number": 0,
      "ref": "L-10234",
      "lead_type": "buy",
      "temperature": "hot",
      "score": 0,
      "score_probability": 0,
      "probability_band": "high",
      "pipeline_id": "cmusrceel0000q7kaafxqi1om",
      "status": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "key": "string",
        "name": "string",
        "color": "string",
        "category": "open"
      },
      "sub_status": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "key": "string",
        "name": "string"
      },
      "status_changed_at": "2026-10-06T05:30:00.000Z",
      "contact": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "phone": "string",
        "email": "string",
        "city": "string",
        "is_nri": true,
        "country": "string",
        "phones": [
          "string"
        ],
        "phone_details": [
          {
            "id": "cmusrceel0000q7kaafxqi1om",
            "label": "string",
            "is_primary": true,
            "is_whatsapp": true,
            "country": "string"
          }
        ],
        "alternate_email": "string",
        "kinds": [
          "string"
        ],
        "language": "string",
        "dnd": true,
        "blocked": true
      },
      "tags": [
        "string"
      ],
      "flags": [
        "escalate"
      ],
      "owner": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "presales": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "source": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "project_id": "cmusrceel0000q7kaafxqi1om",
      "property_id": "cmusrceel0000q7kaafxqi1om",
      "received_at": "2026-10-06T05:30:00.000Z",
      "last_enquiry_at": "2026-10-06T05:30:00.000Z",
      "next_follow_up_at": "2026-10-06T05:30:00.000Z",
      "last_activity_at": "2026-10-06T05:30:00.000Z",
      "last_contacted_at": "2026-10-06T05:30:00.000Z",
      "enquiry_count": 0,
      "call_attempts": 0,
      "connected_calls": 0,
      "duplicate_kind": "string",
      "duplicate_of_id": "cmusrceel0000q7kaafxqi1om",
      "expected_value": 850000000,
      "requirement": {
        "category": "residential",
        "property_types": [
          "apartment"
        ],
        "bhk": [
          0
        ],
        "budget_min": 850000000,
        "budget_max": 850000000,
        "area_min_sqft": 0,
        "area_max_sqft": 0,
        "area_unit_display": "sqft",
        "locality_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ],
        "location_text": "string",
        "possession": "string",
        "transaction_types": [
          "new_booking"
        ],
        "furnishing": [
          "unfurnished"
        ],
        "facing": [
          "north"
        ],
        "floor_preference": "string",
        "min_bathrooms": 0,
        "parking_required": true,
        "amenity_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ],
        "vastu_required": true,
        "purpose": "string",
        "loan_required": true,
        "loan_status": "string",
        "buy_within": "string",
        "move_in_by": "2026-10-06",
        "lease_months": 0,
        "tenant_profile": "string",
        "family_size": 0,
        "has_pets": true,
        "notes": "string"
      },
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z",
      "pipeline": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "sub_source": "string",
      "utm": {},
      "campaign_id": "cmusrceel0000q7kaafxqi1om",
      "team_id": "cmusrceel0000q7kaafxqi1om",
      "branch_id": "cmusrceel0000q7kaafxqi1om",
      "partner_id": "cmusrceel0000q7kaafxqi1om",
      "partner_tag_expires_at": "2026-10-06T05:30:00.000Z",
      "assigned_at": "2026-10-06T05:30:00.000Z",
      "assigned_via": "string",
      "rotation_count": 0,
      "expected_close_on": "2026-10-06",
      "first_response_at": "2026-10-06T05:30:00.000Z",
      "site_visits_done": 0,
      "won_at": "2026-10-06T05:30:00.000Z",
      "lost_at": "2026-10-06T05:30:00.000Z",
      "lost_note": "string",
      "phone_verified": true,
      "ai_handled": true,
      "score_reasons": null,
      "custom": {},
      "open_tasks": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "type": "string",
          "title": "string",
          "due_at": "2026-10-06T05:30:00.000Z",
          "assignee_id": "cmusrceel0000q7kaafxqi1om",
          "is_system": true
        }
      ],
      "enquiries": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "source": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "name": "string"
          },
          "sub_source": "string",
          "campaign_ref": "string",
          "message": "string",
          "is_reenquiry": true,
          "received_at": "2026-10-06T05:30:00.000Z"
        }
      ],
      "permissions": {
        "can_edit": true,
        "can_assign": true,
        "can_delete": 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.
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.