Lead sources

Sources with cost, defaults, ingestion endpoints, health, logs with replay and the ingestion dashboard.

GET/v1/inbound-emails

Inbound lead emails

Newest first (keyset pagination); `status=review` is the review queue.

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

Parameters

statusquery: "received" | "ingested" | "review" | "rejected" | "ignored" | "failed" or "all"
source_idquery: Id
Opaque record id.
cursorquery: string
limitquery: integer

Response · 200

datarequired: array of InboundEmail
metarequired: PageMeta

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "source_id": "cmusrceel0000q7kaafxqi1om",
      "connection_id": "cmusrceel0000q7kaafxqi1om",
      "to_address": "string",
      "from_address": "string",
      "subject": "string",
      "transport": "string",
      "kind": "lead",
      "status": "received",
      "review_reason": "string",
      "authenticated": true,
      "auth": {
        "receiver": "string",
        "spf": "string",
        "dmarc": "string",
        "arc": "string",
        "dkim": [
          "string"
        ],
        "arc_dkim": [
          "string"
        ],
        "authenticated_for": "string",
        "via": "dkim"
      },
      "parser": "string",
      "confidence": 0,
      "error": "string",
      "size_bytes": 0,
      "has_raw": true,
      "ingest_event_id": "cmusrceel0000q7kaafxqi1om",
      "lead_id": "cmusrceel0000q7kaafxqi1om",
      "reviewed_by_id": "string",
      "reviewed_at": "2026-10-06T05:30:00.000Z",
      "received_at": "2026-10-06T05:30:00.000Z",
      "processed_at": "2026-10-06T05:30:00.000Z",
      "suggestion": {
        "portal": "string",
        "lead_id": "string",
        "fields": {},
        "answers": [
          []
        ],
        "submitted_at": "string",
        "text": "string",
        "notes": [
          "string"
        ],
        "ai": {
          "confidence": 0,
          "credits": 0,
          "request_id": "string"
        },
        "forwarding": {
          "provider": "gmail",
          "requested_by": "string",
          "code": "string",
          "link": "string",
          "authenticated": true
        }
      }
    }
  ],
  "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/inbound-emails/summary

Emails waiting for review

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

Response · 200

datarequired: object
data.pendingrequired: integer
data.last_received_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
metarequired: object

Request

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

Response example

{
  "data": {
    "pending": 0,
    "last_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.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/inbound-emails/{id}

An inbound lead email with its suggestion and authentication verdicts

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: InboundEmail
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "source_id": "cmusrceel0000q7kaafxqi1om",
    "connection_id": "cmusrceel0000q7kaafxqi1om",
    "to_address": "string",
    "from_address": "string",
    "subject": "string",
    "transport": "string",
    "kind": "lead",
    "status": "received",
    "review_reason": "string",
    "authenticated": true,
    "auth": {
      "receiver": "string",
      "spf": "string",
      "dmarc": "string",
      "arc": "string",
      "dkim": [
        "string"
      ],
      "arc_dkim": [
        "string"
      ],
      "authenticated_for": "string",
      "via": "dkim"
    },
    "parser": "string",
    "confidence": 0,
    "error": "string",
    "size_bytes": 0,
    "has_raw": true,
    "ingest_event_id": "cmusrceel0000q7kaafxqi1om",
    "lead_id": "cmusrceel0000q7kaafxqi1om",
    "reviewed_by_id": "string",
    "reviewed_at": "2026-10-06T05:30:00.000Z",
    "received_at": "2026-10-06T05:30:00.000Z",
    "processed_at": "2026-10-06T05:30:00.000Z",
    "suggestion": {
      "portal": "string",
      "lead_id": "string",
      "fields": {},
      "answers": [
        []
      ],
      "submitted_at": "string",
      "text": "string",
      "notes": [
        "string"
      ],
      "ai": {
        "confidence": 0,
        "credits": 0,
        "request_id": "string"
      },
      "forwarding": {
        "provider": "gmail",
        "requested_by": "string",
        "code": "string",
        "link": "string",
        "authenticated": 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/inbound-emails/{id}/approve

Approve an email in review

Applies the edits and runs the lead pipeline (dedupe, the TRAI enquiry window, assignment) like any source.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

fields: map of string or null

Response · 200

datarequired: object
data.emailrequired: InboundEmail
data.event_idrequired: Id
Opaque record id.
data.duplicaterequired: boolean
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/inbound-emails/{id}/approve' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"fields":{}}'

Response example

{
  "data": {
    "email": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "source_id": "cmusrceel0000q7kaafxqi1om",
      "connection_id": "cmusrceel0000q7kaafxqi1om",
      "to_address": "string",
      "from_address": "string",
      "subject": "string",
      "transport": "string",
      "kind": "lead",
      "status": "received",
      "review_reason": "string",
      "authenticated": true,
      "auth": {
        "receiver": "string",
        "spf": "string",
        "dmarc": "string",
        "arc": "string",
        "dkim": [
          "string"
        ],
        "arc_dkim": [
          "string"
        ],
        "authenticated_for": "string",
        "via": "dkim"
      },
      "parser": "string",
      "confidence": 0,
      "error": "string",
      "size_bytes": 0,
      "has_raw": true,
      "ingest_event_id": "cmusrceel0000q7kaafxqi1om",
      "lead_id": "cmusrceel0000q7kaafxqi1om",
      "reviewed_by_id": "string",
      "reviewed_at": "2026-10-06T05:30:00.000Z",
      "received_at": "2026-10-06T05:30:00.000Z",
      "processed_at": "2026-10-06T05:30:00.000Z",
      "suggestion": {
        "portal": "string",
        "lead_id": "string",
        "fields": {},
        "answers": [
          []
        ],
        "submitted_at": "string",
        "text": "string",
        "notes": [
          "string"
        ],
        "ai": {
          "confidence": 0,
          "credits": 0,
          "request_id": "string"
        },
        "forwarding": {
          "provider": "gmail",
          "requested_by": "string",
          "code": "string",
          "link": "string",
          "authenticated": true
        }
      }
    },
    "event_id": "cmusrceel0000q7kaafxqi1om",
    "duplicate": 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/inbound-emails/{id}/dismiss

Mark a forwarding confirmation as handled

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: InboundEmail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/inbound-emails/{id}/dismiss' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "source_id": "cmusrceel0000q7kaafxqi1om",
    "connection_id": "cmusrceel0000q7kaafxqi1om",
    "to_address": "string",
    "from_address": "string",
    "subject": "string",
    "transport": "string",
    "kind": "lead",
    "status": "received",
    "review_reason": "string",
    "authenticated": true,
    "auth": {
      "receiver": "string",
      "spf": "string",
      "dmarc": "string",
      "arc": "string",
      "dkim": [
        "string"
      ],
      "arc_dkim": [
        "string"
      ],
      "authenticated_for": "string",
      "via": "dkim"
    },
    "parser": "string",
    "confidence": 0,
    "error": "string",
    "size_bytes": 0,
    "has_raw": true,
    "ingest_event_id": "cmusrceel0000q7kaafxqi1om",
    "lead_id": "cmusrceel0000q7kaafxqi1om",
    "reviewed_by_id": "string",
    "reviewed_at": "2026-10-06T05:30:00.000Z",
    "received_at": "2026-10-06T05:30:00.000Z",
    "processed_at": "2026-10-06T05:30:00.000Z",
    "suggestion": {
      "portal": "string",
      "lead_id": "string",
      "fields": {},
      "answers": [
        []
      ],
      "submitted_at": "string",
      "text": "string",
      "notes": [
        "string"
      ],
      "ai": {
        "confidence": 0,
        "credits": 0,
        "request_id": "string"
      },
      "forwarding": {
        "provider": "gmail",
        "requested_by": "string",
        "code": "string",
        "link": "string",
        "authenticated": 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/inbound-emails/{id}/raw

The raw email (.eml) — TRAI enquiry evidence

A presigned link valid for a few minutes.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

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

Request

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

Response example

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

Errors

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

POST/v1/inbound-emails/{id}/reject

Reject an email in review

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

reason: string or null

Response · 200

datarequired: InboundEmail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/inbound-emails/{id}/reject' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"reason":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "source_id": "cmusrceel0000q7kaafxqi1om",
    "connection_id": "cmusrceel0000q7kaafxqi1om",
    "to_address": "string",
    "from_address": "string",
    "subject": "string",
    "transport": "string",
    "kind": "lead",
    "status": "received",
    "review_reason": "string",
    "authenticated": true,
    "auth": {
      "receiver": "string",
      "spf": "string",
      "dmarc": "string",
      "arc": "string",
      "dkim": [
        "string"
      ],
      "arc_dkim": [
        "string"
      ],
      "authenticated_for": "string",
      "via": "dkim"
    },
    "parser": "string",
    "confidence": 0,
    "error": "string",
    "size_bytes": 0,
    "has_raw": true,
    "ingest_event_id": "cmusrceel0000q7kaafxqi1om",
    "lead_id": "cmusrceel0000q7kaafxqi1om",
    "reviewed_by_id": "string",
    "reviewed_at": "2026-10-06T05:30:00.000Z",
    "received_at": "2026-10-06T05:30:00.000Z",
    "processed_at": "2026-10-06T05:30:00.000Z",
    "suggestion": {
      "portal": "string",
      "lead_id": "string",
      "fields": {},
      "answers": [
        []
      ],
      "submitted_at": "string",
      "text": "string",
      "notes": [
        "string"
      ],
      "ai": {
        "confidence": 0,
        "credits": 0,
        "request_id": "string"
      },
      "forwarding": {
        "provider": "gmail",
        "requested_by": "string",
        "code": "string",
        "link": "string",
        "authenticated": 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/sources

Lead sources

Every lead source with its defaults, endpoints and health (members who see Lead sources or sources ROI).

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

Parameters

include_inactivequery: string
Default true.
typequery: LeadSourceType

Response · 200

datarequired: array of LeadSourceDetail
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "type": "portal",
      "provider": "string",
      "color": "string",
      "is_active": true,
      "monthly_cost": 850000000,
      "default_pipeline_id": "cmusrceel0000q7kaafxqi1om",
      "default_project_id": "cmusrceel0000q7kaafxqi1om",
      "default_tags": [
        "string"
      ],
      "assignment_rule_id": "cmusrceel0000q7kaafxqi1om",
      "default_owner_id": "cmusrceel0000q7kaafxqi1om",
      "default_lead_type": "buy",
      "expected_every_hours": 0,
      "expected_every_hours_learned": true,
      "alarm_member_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "allowed_ips": [
        "string"
      ],
      "connection_id": "cmusrceel0000q7kaafxqi1om",
      "field_mapping": {},
      "endpoints": {
        "lead_push_url": "string",
        "email_address": "string",
        "email_status": "on",
        "qr_codes": [
          {
            "id": "cmusrceel0000q7kaafxqi1om",
            "name": "string",
            "short_code": "string",
            "url": "string",
            "scans": 0
          }
        ]
      },
      "health": {
        "status": "ok",
        "last_lead_at": "2026-10-06T05:30:00.000Z",
        "last_event_at": "2026-10-06T05:30:00.000Z",
        "leads_24h": 0,
        "leads_7d": 0,
        "events_24h": 0,
        "failed_24h": 0,
        "rejected_24h": 0,
        "duplicates_7d": 0,
        "error_rate_24h": 0,
        "silent_for_hours": 0
      },
      "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.
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/sources

Create a lead source

Creates a source with its own Lead Push URL token.

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

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

namerequired: string
typerequired: LeadSourceType
provider: string or null
color: string or null
monthly_cost: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
default_pipeline_id: Id or null
Opaque record id.
default_project_id: Id or null
Opaque record id.
default_owner_id: Id or null
Opaque record id.
assignment_rule_id: Id or null
Opaque record id.
default_tags: array of string
default_lead_type: LeadType or null
expected_every_hours: integer or null
alarm_member_ids: array of Id
Opaque record id.
allowed_ips: array of string
field_mapping: FieldMapping or null
Incoming key (dotted for nested JSON / XML, matched case-insensitively) → PropZolo field.
is_active: boolean

Response · 201

datarequired: LeadSourceDetail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/sources' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","type":"portal","provider":"string","color":"#6D5DFC","monthly_cost":0,"default_pipeline_id":"cmusrceel0000q7kaafxqi1om","default_project_id":"cmusrceel0000q7kaafxqi1om","default_owner_id":"cmusrceel0000q7kaafxqi1om","assignment_rule_id":"cmusrceel0000q7kaafxqi1om","default_tags":["string"],"default_lead_type":"buy","expected_every_hours":1,"alarm_member_ids":["cmusrceel0000q7kaafxqi1om"],"allowed_ips":["string"],"field_mapping":{"SenderMobile":"phone","QueryInfo":"message","lead.budget":"budget","remarks":"ignore"},"is_active":true}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "type": "portal",
    "provider": "string",
    "color": "string",
    "is_active": true,
    "monthly_cost": 850000000,
    "default_pipeline_id": "cmusrceel0000q7kaafxqi1om",
    "default_project_id": "cmusrceel0000q7kaafxqi1om",
    "default_tags": [
      "string"
    ],
    "assignment_rule_id": "cmusrceel0000q7kaafxqi1om",
    "default_owner_id": "cmusrceel0000q7kaafxqi1om",
    "default_lead_type": "buy",
    "expected_every_hours": 0,
    "expected_every_hours_learned": true,
    "alarm_member_ids": [
      "cmusrceel0000q7kaafxqi1om"
    ],
    "allowed_ips": [
      "string"
    ],
    "connection_id": "cmusrceel0000q7kaafxqi1om",
    "field_mapping": {},
    "endpoints": {
      "lead_push_url": "string",
      "email_address": "string",
      "email_status": "on",
      "qr_codes": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string",
          "short_code": "string",
          "url": "string",
          "scans": 0
        }
      ]
    },
    "health": {
      "status": "ok",
      "last_lead_at": "2026-10-06T05:30:00.000Z",
      "last_event_at": "2026-10-06T05:30:00.000Z",
      "leads_24h": 0,
      "leads_7d": 0,
      "events_24h": 0,
      "failed_24h": 0,
      "rejected_24h": 0,
      "duplicates_7d": 0,
      "error_rate_24h": 0,
      "silent_for_hours": 0
    },
    "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.

GET/v1/sources/stats

Ingestion dashboard

Outcomes per source and per day, provider → lead latency against the SLO, silent sources.

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

Parameters

daysquery: integer

Response · 200

datarequired: IngestionStats
metarequired: object

Request

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

Response example

{
  "data": {
    "window": {
      "from": "2026-10-06T05:30:00.000Z",
      "to": "2026-10-06T05:30:00.000Z",
      "days": 0
    },
    "totals": {
      "events": 0,
      "processed": 0,
      "duplicate": 0,
      "rejected": 0,
      "failed": 0,
      "pending": 0
    },
    "latency": {
      "samples": 0,
      "p50_ms": 0,
      "p95_ms": 0,
      "ingest_p95_ms": 0,
      "slo_ms": 0
    },
    "by_day": [
      {
        "date": "string",
        "events": 0,
        "processed": 0,
        "duplicate": 0,
        "rejected": 0,
        "failed": 0,
        "pending": 0
      }
    ],
    "by_source": [
      {
        "source_id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "type": "string",
        "provider": "string",
        "is_active": true,
        "last_event_at": "2026-10-06T05:30:00.000Z",
        "last_lead_at": "2026-10-06T05:30:00.000Z",
        "health_status": "ok",
        "silent_for_hours": 0,
        "expected_every_hours": 0,
        "events": 0,
        "processed": 0,
        "duplicate": 0,
        "rejected": 0,
        "failed": 0,
        "pending": 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.
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/sources/{id}

A lead source

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: LeadSourceDetail
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "type": "portal",
    "provider": "string",
    "color": "string",
    "is_active": true,
    "monthly_cost": 850000000,
    "default_pipeline_id": "cmusrceel0000q7kaafxqi1om",
    "default_project_id": "cmusrceel0000q7kaafxqi1om",
    "default_tags": [
      "string"
    ],
    "assignment_rule_id": "cmusrceel0000q7kaafxqi1om",
    "default_owner_id": "cmusrceel0000q7kaafxqi1om",
    "default_lead_type": "buy",
    "expected_every_hours": 0,
    "expected_every_hours_learned": true,
    "alarm_member_ids": [
      "cmusrceel0000q7kaafxqi1om"
    ],
    "allowed_ips": [
      "string"
    ],
    "connection_id": "cmusrceel0000q7kaafxqi1om",
    "field_mapping": {},
    "endpoints": {
      "lead_push_url": "string",
      "email_address": "string",
      "email_status": "on",
      "qr_codes": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string",
          "short_code": "string",
          "url": "string",
          "scans": 0
        }
      ]
    },
    "health": {
      "status": "ok",
      "last_lead_at": "2026-10-06T05:30:00.000Z",
      "last_event_at": "2026-10-06T05:30:00.000Z",
      "leads_24h": 0,
      "leads_7d": 0,
      "events_24h": 0,
      "failed_24h": 0,
      "rejected_24h": 0,
      "duplicates_7d": 0,
      "error_rate_24h": 0,
      "silent_for_hours": 0
    },
    "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.
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/sources/{id}

Update a lead source

Name, type, cost, defaults, field mapping, silent-source alarm, active flag.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

name: string
type: LeadSourceType
provider: string or null
color: string or null
monthly_cost: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
default_pipeline_id: Id or null
Opaque record id.
default_project_id: Id or null
Opaque record id.
default_owner_id: Id or null
Opaque record id.
assignment_rule_id: Id or null
Opaque record id.
default_tags: array of string
default_lead_type: LeadType or null
expected_every_hours: integer or null
alarm_member_ids: array of Id
Opaque record id.
allowed_ips: array of string
field_mapping: FieldMapping or null
Incoming key (dotted for nested JSON / XML, matched case-insensitively) → PropZolo field.
is_active: boolean

Response · 200

datarequired: LeadSourceDetail
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/sources/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","type":"portal","provider":"string","color":"#6D5DFC","monthly_cost":0,"default_pipeline_id":"cmusrceel0000q7kaafxqi1om","default_project_id":"cmusrceel0000q7kaafxqi1om","default_owner_id":"cmusrceel0000q7kaafxqi1om","assignment_rule_id":"cmusrceel0000q7kaafxqi1om","default_tags":["string"],"default_lead_type":"buy","expected_every_hours":1,"alarm_member_ids":["cmusrceel0000q7kaafxqi1om"],"allowed_ips":["string"],"field_mapping":{"SenderMobile":"phone","QueryInfo":"message","lead.budget":"budget","remarks":"ignore"},"is_active":true}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "type": "portal",
    "provider": "string",
    "color": "string",
    "is_active": true,
    "monthly_cost": 850000000,
    "default_pipeline_id": "cmusrceel0000q7kaafxqi1om",
    "default_project_id": "cmusrceel0000q7kaafxqi1om",
    "default_tags": [
      "string"
    ],
    "assignment_rule_id": "cmusrceel0000q7kaafxqi1om",
    "default_owner_id": "cmusrceel0000q7kaafxqi1om",
    "default_lead_type": "buy",
    "expected_every_hours": 0,
    "expected_every_hours_learned": true,
    "alarm_member_ids": [
      "cmusrceel0000q7kaafxqi1om"
    ],
    "allowed_ips": [
      "string"
    ],
    "connection_id": "cmusrceel0000q7kaafxqi1om",
    "field_mapping": {},
    "endpoints": {
      "lead_push_url": "string",
      "email_address": "string",
      "email_status": "on",
      "qr_codes": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string",
          "short_code": "string",
          "url": "string",
          "scans": 0
        }
      ]
    },
    "health": {
      "status": "ok",
      "last_lead_at": "2026-10-06T05:30:00.000Z",
      "last_event_at": "2026-10-06T05:30:00.000Z",
      "leads_24h": 0,
      "leads_7d": 0,
      "events_24h": 0,
      "failed_24h": 0,
      "rejected_24h": 0,
      "duplicates_7d": 0,
      "error_rate_24h": 0,
      "silent_for_hours": 0
    },
    "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.
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/sources/{id}

Delete an unused lead source

A source that already has leads or ingestion history answers 409 — deactivate it instead.

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

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/sources/{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/sources/{id}/email

A source’s inbound email address

The address, mails waiting for review and open Gmail / Outlook forwarding confirmations.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: SourceInboundEmail
metarequired: object

Request

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

Response example

{
  "data": {
    "available": true,
    "mailbox": {
      "connection_id": "cmusrceel0000q7kaafxqi1om",
      "address": "string",
      "status": "string",
      "created_at": "2026-10-06T05:30:00.000Z",
      "last_received_at": "2026-10-06T05:30:00.000Z"
    },
    "pending_review": 0,
    "last_received_at": "2026-10-06T05:30:00.000Z",
    "forwarding": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "received_at": "2026-10-06T05:30:00.000Z",
        "confirmation": {
          "provider": "gmail",
          "requested_by": "string",
          "code": "string",
          "link": "string",
          "authenticated": 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/sources/{id}/email

Turn on a source’s inbound address

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: SourceInboundEmail
metarequired: object

Request

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

Response example

{
  "data": {
    "available": true,
    "mailbox": {
      "connection_id": "cmusrceel0000q7kaafxqi1om",
      "address": "string",
      "status": "string",
      "created_at": "2026-10-06T05:30:00.000Z",
      "last_received_at": "2026-10-06T05:30:00.000Z"
    },
    "pending_review": 0,
    "last_received_at": "2026-10-06T05:30:00.000Z",
    "forwarding": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "received_at": "2026-10-06T05:30:00.000Z",
        "confirmation": {
          "provider": "gmail",
          "requested_by": "string",
          "code": "string",
          "link": "string",
          "authenticated": 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.

DELETE/v1/sources/{id}/email

Turn off a source’s inbound address

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: SourceInboundEmail
metarequired: object

Request

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

Response example

{
  "data": {
    "available": true,
    "mailbox": {
      "connection_id": "cmusrceel0000q7kaafxqi1om",
      "address": "string",
      "status": "string",
      "created_at": "2026-10-06T05:30:00.000Z",
      "last_received_at": "2026-10-06T05:30:00.000Z"
    },
    "pending_review": 0,
    "last_received_at": "2026-10-06T05:30:00.000Z",
    "forwarding": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "received_at": "2026-10-06T05:30:00.000Z",
        "confirmation": {
          "provider": "gmail",
          "requested_by": "string",
          "code": "string",
          "link": "string",
          "authenticated": 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/sources/{id}/email/rotate

Issue a new inbound address

The old address stops receiving at once — update the forwarding rule.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: SourceInboundEmail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/sources/{id}/email/rotate' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "available": true,
    "mailbox": {
      "connection_id": "cmusrceel0000q7kaafxqi1om",
      "address": "string",
      "status": "string",
      "created_at": "2026-10-06T05:30:00.000Z",
      "last_received_at": "2026-10-06T05:30:00.000Z"
    },
    "pending_review": 0,
    "last_received_at": "2026-10-06T05:30:00.000Z",
    "forwarding": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "received_at": "2026-10-06T05:30:00.000Z",
        "confirmation": {
          "provider": "gmail",
          "requested_by": "string",
          "code": "string",
          "link": "string",
          "authenticated": 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/sources/{id}/logs

Ingestion log of a source

Recent ingest events, newest first (keyset pagination); failed events are dead letters to replay.

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

Parameters

idpathrequired: Id
Opaque record id.
statusquery: IngestStatus
cursorquery: string
limitquery: integer

Response · 200

datarequired: array of IngestLogEntry
metarequired: PageMeta

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "source_id": "cmusrceel0000q7kaafxqi1om",
      "channel": "string",
      "provider": "string",
      "external_id": "string",
      "status": "received",
      "error": "string",
      "lead_id": "cmusrceel0000q7kaafxqi1om",
      "received_at": "2026-10-06T05:30:00.000Z",
      "processed_at": "2026-10-06T05:30:00.000Z",
      "attempts": 0,
      "replays": 0,
      "outcome": "string",
      "reject_reason": "string",
      "latency_ms": 0,
      "dead_letter": true,
      "summary": {
        "name": "string",
        "phone": "string",
        "email": "string"
      }
    }
  ],
  "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.
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/sources/{id}/logs/{eventId}

One ingest event with its archived payload

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

Parameters

idpathrequired: Id
Opaque record id.
eventIdpathrequired: Id
Opaque record id.

Response · 200

datarequired: IngestLogDetail
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "source_id": "cmusrceel0000q7kaafxqi1om",
    "channel": "string",
    "provider": "string",
    "external_id": "string",
    "status": "received",
    "error": "string",
    "lead_id": "cmusrceel0000q7kaafxqi1om",
    "received_at": "2026-10-06T05:30:00.000Z",
    "processed_at": "2026-10-06T05:30:00.000Z",
    "attempts": 0,
    "replays": 0,
    "outcome": "string",
    "reject_reason": "string",
    "latency_ms": 0,
    "dead_letter": true,
    "summary": {
      "name": "string",
      "phone": "string",
      "email": "string"
    },
    "payload": null,
    "normalized": null
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
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/sources/{id}/logs/{eventId}/replay

Replay an ingest event

Re-runs the pipeline for a failed or rejected event (e.g. after fixing the field mapping).

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

Parameters

idpathrequired: Id
Opaque record id.
eventIdpathrequired: Id
Opaque record id.

Response · 202

datarequired: object
data.idrequired: Id
Opaque record id.
data.statusrequired: "received"
data.queuedrequired: boolean
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/sources/{id}/logs/{eventId}/replay' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "received",
    "queued": 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/sources/{id}/rotate-token

Rotate the Lead Push URL

Issues a new URL token; the old URL stops working at once.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: LeadSourceDetail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/sources/{id}/rotate-token' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "type": "portal",
    "provider": "string",
    "color": "string",
    "is_active": true,
    "monthly_cost": 850000000,
    "default_pipeline_id": "cmusrceel0000q7kaafxqi1om",
    "default_project_id": "cmusrceel0000q7kaafxqi1om",
    "default_tags": [
      "string"
    ],
    "assignment_rule_id": "cmusrceel0000q7kaafxqi1om",
    "default_owner_id": "cmusrceel0000q7kaafxqi1om",
    "default_lead_type": "buy",
    "expected_every_hours": 0,
    "expected_every_hours_learned": true,
    "alarm_member_ids": [
      "cmusrceel0000q7kaafxqi1om"
    ],
    "allowed_ips": [
      "string"
    ],
    "connection_id": "cmusrceel0000q7kaafxqi1om",
    "field_mapping": {},
    "endpoints": {
      "lead_push_url": "string",
      "email_address": "string",
      "email_status": "on",
      "qr_codes": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string",
          "short_code": "string",
          "url": "string",
          "scans": 0
        }
      ]
    },
    "health": {
      "status": "ok",
      "last_lead_at": "2026-10-06T05:30:00.000Z",
      "last_event_at": "2026-10-06T05:30:00.000Z",
      "leads_24h": 0,
      "leads_7d": 0,
      "events_24h": 0,
      "failed_24h": 0,
      "rejected_24h": 0,
      "duplicates_7d": 0,
      "error_rate_24h": 0,
      "silent_for_hours": 0
    },
    "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.
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/sources/{id}/test-capture

Listen for a test lead

Long-polls (up to `wait` seconds) for the next event of the source received after `since` and describes its incoming keys with mapping suggestions. Without `since`, returns the latest event at once.

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

Parameters

idpathrequired: Id
Opaque record id.
sincequery: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
waitquery: integer

Response · 200

datarequired: object
data.capturedrequired: boolean
data.eventrequired: IngestLogDetail or null
data.fieldsrequired: array of IncomingFieldDescription
metarequired: object

Request

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

Response example

{
  "data": {
    "captured": true,
    "event": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "source_id": "cmusrceel0000q7kaafxqi1om",
      "channel": "string",
      "provider": "string",
      "external_id": "string",
      "status": "received",
      "error": "string",
      "lead_id": "cmusrceel0000q7kaafxqi1om",
      "received_at": "2026-10-06T05:30:00.000Z",
      "processed_at": "2026-10-06T05:30:00.000Z",
      "attempts": 0,
      "replays": 0,
      "outcome": "string",
      "reject_reason": "string",
      "latency_ms": 0,
      "dead_letter": true,
      "summary": {
        "name": "string",
        "phone": "string",
        "email": "string"
      },
      "payload": null,
      "normalized": null
    },
    "fields": [
      {
        "key": "string",
        "sample": "string",
        "mapped_to": "string",
        "suggested": "string",
        "confidence": 0
      }
    ]
  },
  "meta": {}
}

Errors

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