Automation tools

Zapier, Make and Pabbly: REST-hook subscriptions and polling triggers for API keys.

POST/v1/actions/upsert_contact

Create or update a contact

Finds the contact by phone, then by email, within the key’s scope and updates it (a new number is added, tags are added, an email is set only when the contact has none); otherwise creates it (a name is required). Needs `contacts:write`. Send an `Idempotency-Key`.

Access: API key with contacts:write, or a member session. Permission contacts.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

phone: string or null
email: string or null
name: string or null
first_name: string or null
last_name: string or null
city: string or null
address: string or null
pincode: string or null
occupation: string or null
kinds: array of "buyer" | "tenant" | "owner" | "landlord" | "investor" | "broker" | …
tags: array of string
custom: map of any

Response · 200

datarequired: AutomationContactUpsert
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/actions/upsert_contact' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"phone":"string","email":"string","name":"string","first_name":"string","last_name":"string","city":"string","address":"string","pincode":"string","occupation":"string","kinds":["buyer"],"tags":["string"],"custom":{}}'

Response example

{
  "data": {
    "action": "created",
    "contact_id": "cmusrceel0000q7kaafxqi1om",
    "contact": {}
  },
  "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/actions/upsert_lead

Create or update a lead

An `external_id` seen before finds its lead (type, temperature and custom fields are updated). Otherwise the enquiry goes through the lead pipeline like any portal lead: a known phone / email follows the duplicate policy (a re-enquiry on the open lead or a reopened lead → `updated`; a new or labelled duplicate lead → `created`, never a silent merge), then routing and consent rules apply. Budgets are phrases or rupees (“75 L - 1 Cr”, “8500000”). Needs `leads:write`. Send an `Idempotency-Key`.

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

external_id: string or null
name: string or null
first_name: string or null
last_name: string or null
phone: string or null
alt_phone: string or null
email: string or null
city: string or null
address: string or null
pincode: string or null
message: string or null
budget: string or null
budget_min: string or null
budget_max: string or null
bhk: string or null
property_type: string or null
locality: string or null
project: string or null
possession: string or null
purpose: string or null
campaign: string or null
sub_source: string or null
lead_type: "buy" | "rent" | "sell" | "let_out" | "invest" or null
temperature: "hot" | "warm" | "cold" or null
source_id: Id or null
Opaque record id.
utm: map of string
custom: map of string

Response · 200

datarequired: AutomationLeadUpsert
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/actions/upsert_lead' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"external_id":"string","name":"string","first_name":"string","last_name":"string","phone":"string","alt_phone":"string","email":"string","city":"string","address":"string","pincode":"string","message":"string","budget":"string","budget_min":"string","budget_max":"string","bhk":"string","property_type":"string","locality":"string","project":"string","possession":"string","purpose":"string","campaign":"string","sub_source":"string","lead_type":"buy","temperature":"hot","source_id":"cmusrceel0000q7kaafxqi1om","utm":{},"custom":{}}'

Response example

{
  "data": {
    "action": "created",
    "outcome": "created",
    "lead_id": "cmusrceel0000q7kaafxqi1om",
    "contact_id": "cmusrceel0000q7kaafxqi1om",
    "duplicate_kind": "string",
    "duplicate_of_id": "cmusrceel0000q7kaafxqi1om",
    "lead": {}
  },
  "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/hooks

The API key’s REST hooks

Access: API key with webhooks:manage, or a member session. Permission settings.integrations.

Response · 200

datarequired: array of WebhookEndpoint
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "kind": "endpoint",
      "name": "string",
      "url": "string",
      "events": [
        "string"
      ],
      "api_version": "2026-10-01",
      "trigger": "new_lead",
      "app": "zapier",
      "api_key": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "prefix": "string"
      },
      "is_active": true,
      "disabled_reason": "string",
      "disabled_at": "2026-10-06T05:30:00.000Z",
      "failure_count": 0,
      "last_delivery_at": "2026-10-06T05:30:00.000Z",
      "last_success_at": "2026-10-06T05:30:00.000Z",
      "last_failure_at": "2026-10-06T05:30:00.000Z",
      "previous_secret_expires_at": "2026-10-06T05:30:00.000Z",
      "created_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_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.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/hooks

Subscribe a REST hook (Zapier, Make, Pabbly)

Each matching event POSTs the trigger’s record (the same shape as GET /api/v1/triggers/{trigger}) to `target_url`, signed with the X-PropZolo-Signature scheme. Needs an API key with `webhooks:manage` and the trigger’s read scope. Subscribing the same URL again returns the existing subscription. A 410 answer removes it.

Access: API key with webhooks:manage, or a member session. Permission settings.integrations.

Request body

target_urlrequired: string
triggerrequired: AutomationTriggerKey
app: "zapier" | "make" | "pabbly" | "other" or null

Response · 201

datarequired: WebhookEndpoint
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/hooks' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"target_url":"string","trigger":"new_lead","app":"zapier"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "kind": "endpoint",
    "name": "string",
    "url": "string",
    "events": [
      "string"
    ],
    "api_version": "2026-10-01",
    "trigger": "new_lead",
    "app": "zapier",
    "api_key": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "prefix": "string"
    },
    "is_active": true,
    "disabled_reason": "string",
    "disabled_at": "2026-10-06T05:30:00.000Z",
    "failure_count": 0,
    "last_delivery_at": "2026-10-06T05:30:00.000Z",
    "last_success_at": "2026-10-06T05:30:00.000Z",
    "last_failure_at": "2026-10-06T05:30:00.000Z",
    "previous_secret_expires_at": "2026-10-06T05:30:00.000Z",
    "created_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_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.
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/hooks/{id}

Unsubscribe a REST hook

Only hooks created with the calling API key.

Access: API key with webhooks:manage, or a member session. Permission settings.integrations.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

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

Request

curl -X DELETE 'https://api.propzolo.com/v1/hooks/{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.

GET/v1/searches/contact

Find contacts (automation search)

Contacts matching every parameter given (phone and / or email), oldest first, at most 10. Needs `contacts:read`.

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

Parameters

phonequery: string
Any format: 10 digits read as Indian, +<country code> for NRI numbers (kept as sent).
emailquery: string
Case-insensitive.
limitquery: integer

Response · 200

datarequired: array of map of any
metarequired: object

Request

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

Response example

{
  "data": [
    {}
  ],
  "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.

GET/v1/searches/lead

Find leads (automation search)

Leads matching every parameter given (at least one of phone, email, external_id), newest first, at most 10. `external_id` is the id sent with upsert_lead or a provider’s own lead id. Needs `leads:read`.

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

Parameters

phonequery: string
Any format: 10 digits read as Indian, +<country code> for NRI numbers (kept as sent).
emailquery: string
Case-insensitive.
external_idquery: string
limitquery: integer

Response · 200

datarequired: array of map of any
metarequired: object

Request

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

Response example

{
  "data": [
    {}
  ],
  "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.

GET/v1/triggers

Triggers for automation tools

The triggers with sample records. Apps also use it to test the API key.

Access: API key with leads:read or site_visits:read or deals:read or contacts:read or tasks:read or calls:read or inbox:read or properties:read or receipts:read or webhooks:manage, or a member session. Permission leads.view or site_visits.view or deals.view or contacts.view or tasks.view or calls.view or inbox.view or properties.view or receipts.view or settings.integrations.

Response · 200

datarequired: array of AutomationTrigger
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "key": "new_lead",
      "label": "string",
      "description": "string",
      "event": "string",
      "scope": "string",
      "sample": {}
    }
  ],
  "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.

GET/v1/triggers/{trigger}

Poll a trigger

The newest records the key can see, newest first; `id` is the deduplication key (the record’s id, or `evt_<event id>` for events that can repeat). Field rules of the key’s creator apply (e.g. masked phones). Each trigger needs its own read scope (403 otherwise).

Parameters

triggerpathrequired: AutomationTriggerKey
limitquery: integer

Response · 200

datarequired: array of map of any
metarequired: object

Request

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

Response example

{
  "data": [
    {}
  ],
  "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.

curl -X POST 'https://api.propzolo.com/v1/actions/upsert_contact' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Idempotency-Key: 6c0f1d3e-…' \ -H 'Content-Type: application/json' \ -d '{"phone":"string","email":"string","name":"string","first_name":"string","last_name":"string","city":"string","address":"string","pincode":"string","occupation":"string","kinds":["buyer"],"tags":["string"],"custom":{}}'

curl -X POST 'https://api.propzolo.com/v1/actions/upsert_lead' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Idempotency-Key: 6c0f1d3e-…' \ -H 'Content-Type: application/json' \ -d '{"external_id":"string","name":"string","first_name":"string","last_name":"string","phone":"string","alt_phone":"string","email":"string","city":"string","address":"string","pincode":"string","message":"string","budget":"string","budget_min":"string","budget_max":"string","bhk":"string","property_type":"string","locality":"string","project":"string","possession":"string","purpose":"string","campaign":"string","sub_source":"string","lead_type":"buy","temperature":"hot","source_id":"cmusrceel0000q7kaafxqi1om","utm":{},"custom":{}}'

{ "data": { "action": "created", "outcome": "created", "lead_id": "cmusrceel0000q7kaafxqi1om", "contact_id": "cmusrceel0000q7kaafxqi1om", "duplicate_kind": "string", "duplicate_of_id": "cmusrceel0000q7kaafxqi1om", "lead": {} }, "meta": {} }

{ "data": [ { "id": "cmusrceel0000q7kaafxqi1om", "kind": "endpoint", "name": "string", "url": "string", "events": [ "string" ], "api_version": "2026-10-01", "trigger": "new_lead", "app": "zapier", "api_key": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "prefix": "string" }, "is_active": true, "disabled_reason": "string", "disabled_at": "2026-10-06T05:30:00.000Z", "failure_count": 0, "last_delivery_at": "2026-10-06T05:30:00.000Z", "last_success_at": "2026-10-06T05:30:00.000Z", "last_failure_at": "2026-10-06T05:30:00.000Z", "previous_secret_expires_at": "2026-10-06T05:30:00.000Z", "created_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z" } ], "meta": {} }

curl -X POST 'https://api.propzolo.com/v1/hooks' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"target_url":"string","trigger":"new_lead","app":"zapier"}'

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "kind": "endpoint", "name": "string", "url": "string", "events": [ "string" ], "api_version": "2026-10-01", "trigger": "new_lead", "app": "zapier", "api_key": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "prefix": "string" }, "is_active": true, "disabled_reason": "string", "disabled_at": "2026-10-06T05:30:00.000Z", "failure_count": 0, "last_delivery_at": "2026-10-06T05:30:00.000Z", "last_success_at": "2026-10-06T05:30:00.000Z", "last_failure_at": "2026-10-06T05:30:00.000Z", "previous_secret_expires_at": "2026-10-06T05:30:00.000Z", "created_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z" }, "meta": {} }

GET/v1/triggers/{trigger}

Poll a trigger

Parameters

triggerpathrequired: AutomationTriggerKey
limitquery: integer

Response · 200

datarequired: array of map of any
metarequired: object

Request

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

Response example

{
  "data": [
    {}
  ],
  "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.