Re-activation

Database re-activation: dormant leads picked by preset and filter, reached only on a lawful channel (legal basis per lead), a hold-out group for the lift, the first batch’s approval, the AI agent re-qualifying replies and warm leads handed to people — funnel, lift, cost and the export.

GET/v1/reactivation/programs

Re-activation programmes

Newest first, with live counts; keyset pagination.

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

Parameters

cursorquery: string
Opaque cursor from the previous page (`meta.next_cursor`).
limitquery: integer
Page size, 1–200.
statusquery: "draft" | "active" | "paused" | "stopped"

Response · 200

datarequired: array of ReactivationProgramListItem
metarequired: PageMeta

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "description": "string",
      "status": "draft",
      "status_reason": "string",
      "preset": "lost_cold",
      "channels": [
        "whatsapp_cloud"
      ],
      "holdout_pct": 0,
      "daily_cap": 0,
      "approved": true,
      "launched_at": "2026-10-06T05:30:00.000Z",
      "last_run_on": "string",
      "spent_paise": 850000000,
      "summary": {
        "selected": 0,
        "treatment": 0,
        "holdout": 0,
        "pending": 0,
        "contacted": 0,
        "replied": 0,
        "requalified": 0,
        "handed_off": 0,
        "skipped": 0
      },
      "created_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z",
      "can": {
        "edit": true,
        "send": true,
        "delete": 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.

POST/v1/reactivation/programs

Draft a re-activation programme

The configuration may be partial: defaults fill the rest (lost or cold 30–365 days, 10 % hold-out).

Access: Signed-in members only (web or Android session) — not for API keys. Permission campaigns.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

namerequired: string
description: string or null
config: ReactivationConfig

Response · 201

datarequired: ReactivationProgram
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/reactivation/programs' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","description":"string","config":{"audience":{"preset":"lost_cold","lead_types":["buy"],"dormant_min_days":7,"dormant_max_days":14,"inactive_days":14,"portal_days":7,"inventory_days":1,"min_match_score":40,"smart_list_id":"cmusrceel0000q7kaafxqi1om","filter":null},"channels":{"order":["whatsapp_cloud"],"whatsapp_cloud":{"template_id":"cmusrceel0000q7kaafxqi1om","followup_template_id":"cmusrceel0000q7kaafxqi1om","channel_account_id":"cmusrceel0000q7kaafxqi1om"},"sms":{"template_id":"cmusrceel0000q7kaafxqi1om","followup_template_id":"cmusrceel0000q7kaafxqi1om","channel_account_id":"cmusrceel0000q7kaafxqi1om"},"email":{"template_id":"cmusrceel0000q7kaafxqi1om","followup_template_id":"cmusrceel0000q7kaafxqi1om","channel_account_id":"cmusrceel0000q7kaafxqi1om"},"call_task":{"priority":"normal"}},"message":{"ai":true,"variables":[{"key":"string","hint":"string"}],"instructions":"string","vars":{}},"schedule":{"window":{"start":"string","end":"string"},"daily_cap":1,"budget_paise":0,"holdout_pct":0,"attribution_days":7,"end_on":"2026-10-06"},"follow_up":{"max":0,"after_days":1},"handoff":{"route":"owner","fallback_member_id":"cmusrceel0000q7kaafxqi1om","sla_minutes":15,"when":"requalified","reopen":true}}}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "description": "string",
    "status": "draft",
    "status_reason": "string",
    "preset": "lost_cold",
    "channels": [
      "whatsapp_cloud"
    ],
    "holdout_pct": 0,
    "daily_cap": 0,
    "approved": true,
    "launched_at": "2026-10-06T05:30:00.000Z",
    "last_run_on": "string",
    "spent_paise": 850000000,
    "summary": {
      "selected": 0,
      "treatment": 0,
      "holdout": 0,
      "pending": 0,
      "contacted": 0,
      "replied": 0,
      "requalified": 0,
      "handed_off": 0,
      "skipped": 0
    },
    "created_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "can": {
      "edit": true,
      "send": true,
      "delete": true
    },
    "config": {},
    "compliance": {
      "state": "missing",
      "status": "pass",
      "issues": [
        {
          "source": "rule",
          "category": "string",
          "severity": "block",
          "quote": "string",
          "message": "string",
          "rule_id": "string"
        }
      ],
      "ai_review": "done",
      "checked_at": "string",
      "override": {
        "by": "string",
        "at": "string",
        "reason": "string"
      }
    },
    "approved_at": "2026-10-06T05:30:00.000Z",
    "approved_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "launched_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "paused_at": "2026-10-06T05:30:00.000Z",
    "stopped_at": "2026-10-06T05:30:00.000Z",
    "ai_credits": 0,
    "pending_batch": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "run_on": "string",
      "status": "pending_approval",
      "first": true,
      "counts": {},
      "decided_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "decided_at": "2026-10-06T05:30:00.000Z",
      "decision_note": "string",
      "created_at": "2026-10-06T05:30:00.000Z"
    },
    "batches": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "run_on": "string",
        "status": "pending_approval",
        "first": true,
        "counts": {},
        "decided_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "decided_at": "2026-10-06T05:30:00.000Z",
        "decision_note": "string",
        "created_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/reactivation/programs/{id}

A re-activation programme

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: ReactivationProgram
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "description": "string",
    "status": "draft",
    "status_reason": "string",
    "preset": "lost_cold",
    "channels": [
      "whatsapp_cloud"
    ],
    "holdout_pct": 0,
    "daily_cap": 0,
    "approved": true,
    "launched_at": "2026-10-06T05:30:00.000Z",
    "last_run_on": "string",
    "spent_paise": 850000000,
    "summary": {
      "selected": 0,
      "treatment": 0,
      "holdout": 0,
      "pending": 0,
      "contacted": 0,
      "replied": 0,
      "requalified": 0,
      "handed_off": 0,
      "skipped": 0
    },
    "created_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "can": {
      "edit": true,
      "send": true,
      "delete": true
    },
    "config": {},
    "compliance": {
      "state": "missing",
      "status": "pass",
      "issues": [
        {
          "source": "rule",
          "category": "string",
          "severity": "block",
          "quote": "string",
          "message": "string",
          "rule_id": "string"
        }
      ],
      "ai_review": "done",
      "checked_at": "string",
      "override": {
        "by": "string",
        "at": "string",
        "reason": "string"
      }
    },
    "approved_at": "2026-10-06T05:30:00.000Z",
    "approved_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "launched_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "paused_at": "2026-10-06T05:30:00.000Z",
    "stopped_at": "2026-10-06T05:30:00.000Z",
    "ai_credits": 0,
    "pending_batch": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "run_on": "string",
      "status": "pending_approval",
      "first": true,
      "counts": {},
      "decided_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "decided_at": "2026-10-06T05:30:00.000Z",
      "decision_note": "string",
      "created_at": "2026-10-06T05:30:00.000Z"
    },
    "batches": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "run_on": "string",
        "status": "pending_approval",
        "first": true,
        "counts": {},
        "decided_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "decided_at": "2026-10-06T05:30:00.000Z",
        "decision_note": "string",
        "created_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/reactivation/programs/{id}

Change a draft or paused programme

Send the whole configuration. A change to the audience, channels or messages after the first approval asks for a new approval of the next batch.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

name: string
description: string or null
config: ReactivationConfig

Response · 200

datarequired: ReactivationProgram
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/reactivation/programs/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","description":"string","config":{"audience":{"preset":"lost_cold","lead_types":["buy"],"dormant_min_days":7,"dormant_max_days":14,"inactive_days":14,"portal_days":7,"inventory_days":1,"min_match_score":40,"smart_list_id":"cmusrceel0000q7kaafxqi1om","filter":null},"channels":{"order":["whatsapp_cloud"],"whatsapp_cloud":{"template_id":"cmusrceel0000q7kaafxqi1om","followup_template_id":"cmusrceel0000q7kaafxqi1om","channel_account_id":"cmusrceel0000q7kaafxqi1om"},"sms":{"template_id":"cmusrceel0000q7kaafxqi1om","followup_template_id":"cmusrceel0000q7kaafxqi1om","channel_account_id":"cmusrceel0000q7kaafxqi1om"},"email":{"template_id":"cmusrceel0000q7kaafxqi1om","followup_template_id":"cmusrceel0000q7kaafxqi1om","channel_account_id":"cmusrceel0000q7kaafxqi1om"},"call_task":{"priority":"normal"}},"message":{"ai":true,"variables":[{"key":"string","hint":"string"}],"instructions":"string","vars":{}},"schedule":{"window":{"start":"string","end":"string"},"daily_cap":1,"budget_paise":0,"holdout_pct":0,"attribution_days":7,"end_on":"2026-10-06"},"follow_up":{"max":0,"after_days":1},"handoff":{"route":"owner","fallback_member_id":"cmusrceel0000q7kaafxqi1om","sla_minutes":15,"when":"requalified","reopen":true}}}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "description": "string",
    "status": "draft",
    "status_reason": "string",
    "preset": "lost_cold",
    "channels": [
      "whatsapp_cloud"
    ],
    "holdout_pct": 0,
    "daily_cap": 0,
    "approved": true,
    "launched_at": "2026-10-06T05:30:00.000Z",
    "last_run_on": "string",
    "spent_paise": 850000000,
    "summary": {
      "selected": 0,
      "treatment": 0,
      "holdout": 0,
      "pending": 0,
      "contacted": 0,
      "replied": 0,
      "requalified": 0,
      "handed_off": 0,
      "skipped": 0
    },
    "created_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "can": {
      "edit": true,
      "send": true,
      "delete": true
    },
    "config": {},
    "compliance": {
      "state": "missing",
      "status": "pass",
      "issues": [
        {
          "source": "rule",
          "category": "string",
          "severity": "block",
          "quote": "string",
          "message": "string",
          "rule_id": "string"
        }
      ],
      "ai_review": "done",
      "checked_at": "string",
      "override": {
        "by": "string",
        "at": "string",
        "reason": "string"
      }
    },
    "approved_at": "2026-10-06T05:30:00.000Z",
    "approved_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "launched_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "paused_at": "2026-10-06T05:30:00.000Z",
    "stopped_at": "2026-10-06T05:30:00.000Z",
    "ai_credits": 0,
    "pending_batch": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "run_on": "string",
      "status": "pending_approval",
      "first": true,
      "counts": {},
      "decided_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "decided_at": "2026-10-06T05:30:00.000Z",
      "decision_note": "string",
      "created_at": "2026-10-06T05:30:00.000Z"
    },
    "batches": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "run_on": "string",
        "status": "pending_approval",
        "first": true,
        "counts": {},
        "decided_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "decided_at": "2026-10-06T05:30:00.000Z",
        "decision_note": "string",
        "created_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/reactivation/programs/{id}

Delete a draft that never ran

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

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/reactivation/programs/{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/reactivation/programs/{id}/attempts

The live log of a programme

Latest activity first; leads outside your lead scope are left out. Keyset pagination.

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

Parameters

idpathrequired: Id
Opaque record id.
cursorquery: string
Opaque cursor from the previous page (`meta.next_cursor`).
limitquery: integer
Page size, 1–200.
statusquery: "holdout" | "pending" | "sent" | "replied" | "handed_off" | "skipped" | …
cohortquery: "treatment" | "holdout" | "none"
batch_idquery: Id
Opaque record id.

Response · 200

datarequired: array of ReactivationAttempt
metarequired: PageMeta

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "batch_id": "cmusrceel0000q7kaafxqi1om",
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "name": "string"
      },
      "cohort": "treatment",
      "status": "holdout",
      "channel": "whatsapp_cloud",
      "legal_basis": "string",
      "skip_reason": "string",
      "skip_detail": "string",
      "close_reason": "string",
      "handoff_reason": "string",
      "handoff_member": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "ai_status": "string",
      "followups_sent": 0,
      "selected_at": "2026-10-06T05:30:00.000Z",
      "sent_at": "2026-10-06T05:30:00.000Z",
      "delivered_at": "2026-10-06T05:30:00.000Z",
      "replied_at": "2026-10-06T05:30:00.000Z",
      "requalified_at": "2026-10-06T05:30:00.000Z",
      "handed_off_at": "2026-10-06T05:30:00.000Z",
      "visit_at": "2026-10-06T05:30:00.000Z",
      "deal_won_at": "2026-10-06T05:30:00.000Z",
      "revenue_paise": 850000000,
      "opted_out_at": "2026-10-06T05:30:00.000Z",
      "closed_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.
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/reactivation/programs/{id}/batches/{batchId}

A day’s batch with sample first messages

For the approval: the counts and up to 10 contacted-group leads (within your lead scope) with their message.

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

Parameters

idpathrequired: Id
Opaque record id.
batchIdpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.batchrequired: ReactivationBatch
data.samplesrequired: array of ReactivationMessagePreview
metarequired: object

Request

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

Response example

{
  "data": {
    "batch": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "run_on": "string",
      "status": "pending_approval",
      "first": true,
      "counts": {},
      "decided_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "decided_at": "2026-10-06T05:30:00.000Z",
      "decision_note": "string",
      "created_at": "2026-10-06T05:30:00.000Z"
    },
    "samples": [
      {
        "lead": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "ref": "string",
          "name": "string"
        },
        "channel": "whatsapp_cloud",
        "legal_basis": "string",
        "ai": "done",
        "note": "string",
        "values": {},
        "text": "string",
        "subject": "string",
        "sendable": true,
        "blocks": [
          {
            "reason": "string",
            "detail": "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.
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/reactivation/programs/{id}/batches/{batchId}/approve

Approve the programme’s first batch

The batch goes out within the sending window; later batches no longer wait for approval.

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

Parameters

idpathrequired: Id
Opaque record id.
batchIdpathrequired: Id
Opaque record id.

Request body (optional)

note: string or null

Response · 200

datarequired: ReactivationProgram
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/reactivation/programs/{id}/batches/{batchId}/approve' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "description": "string",
    "status": "draft",
    "status_reason": "string",
    "preset": "lost_cold",
    "channels": [
      "whatsapp_cloud"
    ],
    "holdout_pct": 0,
    "daily_cap": 0,
    "approved": true,
    "launched_at": "2026-10-06T05:30:00.000Z",
    "last_run_on": "string",
    "spent_paise": 850000000,
    "summary": {
      "selected": 0,
      "treatment": 0,
      "holdout": 0,
      "pending": 0,
      "contacted": 0,
      "replied": 0,
      "requalified": 0,
      "handed_off": 0,
      "skipped": 0
    },
    "created_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "can": {
      "edit": true,
      "send": true,
      "delete": true
    },
    "config": {},
    "compliance": {
      "state": "missing",
      "status": "pass",
      "issues": [
        {
          "source": "rule",
          "category": "string",
          "severity": "block",
          "quote": "string",
          "message": "string",
          "rule_id": "string"
        }
      ],
      "ai_review": "done",
      "checked_at": "string",
      "override": {
        "by": "string",
        "at": "string",
        "reason": "string"
      }
    },
    "approved_at": "2026-10-06T05:30:00.000Z",
    "approved_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "launched_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "paused_at": "2026-10-06T05:30:00.000Z",
    "stopped_at": "2026-10-06T05:30:00.000Z",
    "ai_credits": 0,
    "pending_batch": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "run_on": "string",
      "status": "pending_approval",
      "first": true,
      "counts": {},
      "decided_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "decided_at": "2026-10-06T05:30:00.000Z",
      "decision_note": "string",
      "created_at": "2026-10-06T05:30:00.000Z"
    },
    "batches": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "run_on": "string",
        "status": "pending_approval",
        "first": true,
        "counts": {},
        "decided_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "decided_at": "2026-10-06T05:30:00.000Z",
        "decision_note": "string",
        "created_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.

POST/v1/reactivation/programs/{id}/batches/{batchId}/reject

Send the first batch back

Nobody in it is contacted or measured; the programme pauses until it is changed and resumed.

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

Parameters

idpathrequired: Id
Opaque record id.
batchIdpathrequired: Id
Opaque record id.

Request body (optional)

note: string or null

Response · 200

datarequired: ReactivationProgram
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/reactivation/programs/{id}/batches/{batchId}/reject' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "description": "string",
    "status": "draft",
    "status_reason": "string",
    "preset": "lost_cold",
    "channels": [
      "whatsapp_cloud"
    ],
    "holdout_pct": 0,
    "daily_cap": 0,
    "approved": true,
    "launched_at": "2026-10-06T05:30:00.000Z",
    "last_run_on": "string",
    "spent_paise": 850000000,
    "summary": {
      "selected": 0,
      "treatment": 0,
      "holdout": 0,
      "pending": 0,
      "contacted": 0,
      "replied": 0,
      "requalified": 0,
      "handed_off": 0,
      "skipped": 0
    },
    "created_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "can": {
      "edit": true,
      "send": true,
      "delete": true
    },
    "config": {},
    "compliance": {
      "state": "missing",
      "status": "pass",
      "issues": [
        {
          "source": "rule",
          "category": "string",
          "severity": "block",
          "quote": "string",
          "message": "string",
          "rule_id": "string"
        }
      ],
      "ai_review": "done",
      "checked_at": "string",
      "override": {
        "by": "string",
        "at": "string",
        "reason": "string"
      }
    },
    "approved_at": "2026-10-06T05:30:00.000Z",
    "approved_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "launched_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "paused_at": "2026-10-06T05:30:00.000Z",
    "stopped_at": "2026-10-06T05:30:00.000Z",
    "ai_credits": 0,
    "pending_batch": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "run_on": "string",
      "status": "pending_approval",
      "first": true,
      "counts": {},
      "decided_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "decided_at": "2026-10-06T05:30:00.000Z",
      "decision_note": "string",
      "created_at": "2026-10-06T05:30:00.000Z"
    },
    "batches": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "run_on": "string",
        "status": "pending_approval",
        "first": true,
        "counts": {},
        "decided_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "decided_at": "2026-10-06T05:30:00.000Z",
        "decision_note": "string",
        "created_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.

POST/v1/reactivation/programs/{id}/compliance

Run the AI compliance check of the programme’s messages

Company rules, template categories and RERA numbers, then an AI review when needed. Mandatory before launch.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: ReactivationProgram
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "description": "string",
    "status": "draft",
    "status_reason": "string",
    "preset": "lost_cold",
    "channels": [
      "whatsapp_cloud"
    ],
    "holdout_pct": 0,
    "daily_cap": 0,
    "approved": true,
    "launched_at": "2026-10-06T05:30:00.000Z",
    "last_run_on": "string",
    "spent_paise": 850000000,
    "summary": {
      "selected": 0,
      "treatment": 0,
      "holdout": 0,
      "pending": 0,
      "contacted": 0,
      "replied": 0,
      "requalified": 0,
      "handed_off": 0,
      "skipped": 0
    },
    "created_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "can": {
      "edit": true,
      "send": true,
      "delete": true
    },
    "config": {},
    "compliance": {
      "state": "missing",
      "status": "pass",
      "issues": [
        {
          "source": "rule",
          "category": "string",
          "severity": "block",
          "quote": "string",
          "message": "string",
          "rule_id": "string"
        }
      ],
      "ai_review": "done",
      "checked_at": "string",
      "override": {
        "by": "string",
        "at": "string",
        "reason": "string"
      }
    },
    "approved_at": "2026-10-06T05:30:00.000Z",
    "approved_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "launched_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "paused_at": "2026-10-06T05:30:00.000Z",
    "stopped_at": "2026-10-06T05:30:00.000Z",
    "ai_credits": 0,
    "pending_batch": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "run_on": "string",
      "status": "pending_approval",
      "first": true,
      "counts": {},
      "decided_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "decided_at": "2026-10-06T05:30:00.000Z",
      "decision_note": "string",
      "created_at": "2026-10-06T05:30:00.000Z"
    },
    "batches": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "run_on": "string",
        "status": "pending_approval",
        "first": true,
        "counts": {},
        "decided_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "decided_at": "2026-10-06T05:30:00.000Z",
        "decision_note": "string",
        "created_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/reactivation/programs/{id}/compliance/override

Override an AI-only compliance finding

Only blocks raised by the AI review; never a company rule. Audited with the reason.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

reasonrequired: string

Response · 200

datarequired: ReactivationProgram
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "description": "string",
    "status": "draft",
    "status_reason": "string",
    "preset": "lost_cold",
    "channels": [
      "whatsapp_cloud"
    ],
    "holdout_pct": 0,
    "daily_cap": 0,
    "approved": true,
    "launched_at": "2026-10-06T05:30:00.000Z",
    "last_run_on": "string",
    "spent_paise": 850000000,
    "summary": {
      "selected": 0,
      "treatment": 0,
      "holdout": 0,
      "pending": 0,
      "contacted": 0,
      "replied": 0,
      "requalified": 0,
      "handed_off": 0,
      "skipped": 0
    },
    "created_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "can": {
      "edit": true,
      "send": true,
      "delete": true
    },
    "config": {},
    "compliance": {
      "state": "missing",
      "status": "pass",
      "issues": [
        {
          "source": "rule",
          "category": "string",
          "severity": "block",
          "quote": "string",
          "message": "string",
          "rule_id": "string"
        }
      ],
      "ai_review": "done",
      "checked_at": "string",
      "override": {
        "by": "string",
        "at": "string",
        "reason": "string"
      }
    },
    "approved_at": "2026-10-06T05:30:00.000Z",
    "approved_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "launched_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "paused_at": "2026-10-06T05:30:00.000Z",
    "stopped_at": "2026-10-06T05:30:00.000Z",
    "ai_credits": 0,
    "pending_batch": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "run_on": "string",
      "status": "pending_approval",
      "first": true,
      "counts": {},
      "decided_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "decided_at": "2026-10-06T05:30:00.000Z",
      "decision_note": "string",
      "created_at": "2026-10-06T05:30:00.000Z"
    },
    "batches": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "run_on": "string",
        "status": "pending_approval",
        "first": true,
        "counts": {},
        "decided_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "decided_at": "2026-10-06T05:30:00.000Z",
        "decision_note": "string",
        "created_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.

GET/v1/reactivation/programs/{id}/export

Export the attempts as CSV

Group, channel, legal basis, skip / close reasons and milestones of the leads your export scope reaches. Watermarked, formula-safe, audited; step-up for Owner/Admin roles.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

Returned as is.

Request

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

Response example

"string"

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/reactivation/programs/{id}/launch

Launch (or resume) a programme

Checks the company switch, the templates (WhatsApp marketing, DLT promotional), the AI variables and a current passing compliance check. The day’s selection runs at once; its first batch waits for a manager’s approval.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: ReactivationProgram
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "description": "string",
    "status": "draft",
    "status_reason": "string",
    "preset": "lost_cold",
    "channels": [
      "whatsapp_cloud"
    ],
    "holdout_pct": 0,
    "daily_cap": 0,
    "approved": true,
    "launched_at": "2026-10-06T05:30:00.000Z",
    "last_run_on": "string",
    "spent_paise": 850000000,
    "summary": {
      "selected": 0,
      "treatment": 0,
      "holdout": 0,
      "pending": 0,
      "contacted": 0,
      "replied": 0,
      "requalified": 0,
      "handed_off": 0,
      "skipped": 0
    },
    "created_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "can": {
      "edit": true,
      "send": true,
      "delete": true
    },
    "config": {},
    "compliance": {
      "state": "missing",
      "status": "pass",
      "issues": [
        {
          "source": "rule",
          "category": "string",
          "severity": "block",
          "quote": "string",
          "message": "string",
          "rule_id": "string"
        }
      ],
      "ai_review": "done",
      "checked_at": "string",
      "override": {
        "by": "string",
        "at": "string",
        "reason": "string"
      }
    },
    "approved_at": "2026-10-06T05:30:00.000Z",
    "approved_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "launched_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "paused_at": "2026-10-06T05:30:00.000Z",
    "stopped_at": "2026-10-06T05:30:00.000Z",
    "ai_credits": 0,
    "pending_batch": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "run_on": "string",
      "status": "pending_approval",
      "first": true,
      "counts": {},
      "decided_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "decided_at": "2026-10-06T05:30:00.000Z",
      "decision_note": "string",
      "created_at": "2026-10-06T05:30:00.000Z"
    },
    "batches": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "run_on": "string",
        "status": "pending_approval",
        "first": true,
        "counts": {},
        "decided_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "decided_at": "2026-10-06T05:30:00.000Z",
        "decision_note": "string",
        "created_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/reactivation/programs/{id}/message-preview

The first message for a few sample leads

Writes the AI values live for up to 3 leads (metered on the AI wallet), checks them, renders the template and asks the messaging pipeline whether it would send now. Nothing is sent.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

lead_idsrequired: array of Id
Opaque record id.

Response · 200

datarequired: array of ReactivationMessagePreview
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/reactivation/programs/{id}/message-preview' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"lead_ids":["cmusrceel0000q7kaafxqi1om"]}'

Response example

{
  "data": [
    {
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "name": "string"
      },
      "channel": "whatsapp_cloud",
      "legal_basis": "string",
      "ai": "done",
      "note": "string",
      "values": {},
      "text": "string",
      "subject": "string",
      "sendable": true,
      "blocks": [
        {
          "reason": "string",
          "detail": "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.
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/reactivation/programs/{id}/pause

Pause a running programme

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: ReactivationProgram
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "description": "string",
    "status": "draft",
    "status_reason": "string",
    "preset": "lost_cold",
    "channels": [
      "whatsapp_cloud"
    ],
    "holdout_pct": 0,
    "daily_cap": 0,
    "approved": true,
    "launched_at": "2026-10-06T05:30:00.000Z",
    "last_run_on": "string",
    "spent_paise": 850000000,
    "summary": {
      "selected": 0,
      "treatment": 0,
      "holdout": 0,
      "pending": 0,
      "contacted": 0,
      "replied": 0,
      "requalified": 0,
      "handed_off": 0,
      "skipped": 0
    },
    "created_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "can": {
      "edit": true,
      "send": true,
      "delete": true
    },
    "config": {},
    "compliance": {
      "state": "missing",
      "status": "pass",
      "issues": [
        {
          "source": "rule",
          "category": "string",
          "severity": "block",
          "quote": "string",
          "message": "string",
          "rule_id": "string"
        }
      ],
      "ai_review": "done",
      "checked_at": "string",
      "override": {
        "by": "string",
        "at": "string",
        "reason": "string"
      }
    },
    "approved_at": "2026-10-06T05:30:00.000Z",
    "approved_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "launched_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "paused_at": "2026-10-06T05:30:00.000Z",
    "stopped_at": "2026-10-06T05:30:00.000Z",
    "ai_credits": 0,
    "pending_batch": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "run_on": "string",
      "status": "pending_approval",
      "first": true,
      "counts": {},
      "decided_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "decided_at": "2026-10-06T05:30:00.000Z",
      "decision_note": "string",
      "created_at": "2026-10-06T05:30:00.000Z"
    },
    "batches": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "run_on": "string",
        "status": "pending_approval",
        "first": true,
        "counts": {},
        "decided_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "decided_at": "2026-10-06T05:30:00.000Z",
        "decision_note": "string",
        "created_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/reactivation/programs/{id}/preview

Who the programme would pick today

Counts by first lawful channel and legal basis, leads skipped for want of a lawful channel (by reason), exclusions, and a few sample leads within your lead scope. Nothing is written.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: ReactivationPreview
metarequired: object

Request

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

Response example

{
  "data": {
    "counts": {
      "scanned": 0,
      "paced_out": 0,
      "treatment": 0,
      "holdout": 0,
      "skipped": 0,
      "not_dormant": {},
      "excluded": {},
      "skipped_by": {},
      "channels": {},
      "bases": {},
      "capped": true,
      "truncated": true
    },
    "audience_total": 0,
    "daily_cap": 0,
    "holdout_pct": 0,
    "days_to_cover": 0,
    "windows": [
      {
        "channel": "whatsapp_cloud",
        "open_minutes": 0
      }
    ],
    "samples": [
      {
        "lead": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "ref": "string",
          "name": "string"
        },
        "cohort": "treatment",
        "channel": "whatsapp_cloud",
        "legal_basis": "string",
        "dormant_days": 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.

GET/v1/reactivation/programs/{id}/stats

Funnel, lift against the hold-out group and cost

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: ReactivationStats
metarequired: object

Request

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

Response example

{
  "data": {
    "treatment": {
      "leads": 0,
      "contacted": 0,
      "delivered": 0,
      "replied": 0,
      "requalified": 0,
      "handed_off": 0,
      "visits": 0,
      "deals": 0,
      "revenue_paise": 850000000
    },
    "holdout": {
      "leads": 0,
      "contacted": 0,
      "delivered": 0,
      "replied": 0,
      "requalified": 0,
      "handed_off": 0,
      "visits": 0,
      "deals": 0,
      "revenue_paise": 850000000
    },
    "comparable": true,
    "funnel": [
      {
        "step": "string",
        "count": 0,
        "of_selected": 0,
        "of_previous": 0
      }
    ],
    "lift": [
      {
        "metric": "replied",
        "treatment_rate": 0,
        "holdout_rate": 0,
        "absolute_lift": 0,
        "relative_lift": 0,
        "incremental": 0,
        "p_value": 0,
        "significant": true
      }
    ],
    "revenue": {
      "treatment_per_lead_paise": 850000000,
      "holdout_per_lead_paise": 850000000,
      "incremental_paise": 850000000
    },
    "cost": {
      "wallet_paise": 850000000,
      "ai_paise": 850000000,
      "total_paise": 850000000,
      "per_contacted_paise": 850000000,
      "per_requalified_paise": 850000000,
      "per_incremental_paise": 850000000
    },
    "by_channel": [
      {
        "channel": "string",
        "contacted": 0,
        "replied": 0
      }
    ],
    "legal_bases": [
      {
        "basis": "string",
        "count": 0
      }
    ],
    "skip_reasons": [
      {
        "reason": "string",
        "count": 0
      }
    ],
    "close_reasons": [
      {
        "reason": "string",
        "count": 0
      }
    ],
    "ai_credits": 0,
    "credit_paise": 0
  },
  "meta": {}
}

Errors

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

POST/v1/reactivation/programs/{id}/stop

Stop a programme for good

Nothing more is picked or sent; replies in progress are still handled and measured.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: ReactivationProgram
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "description": "string",
    "status": "draft",
    "status_reason": "string",
    "preset": "lost_cold",
    "channels": [
      "whatsapp_cloud"
    ],
    "holdout_pct": 0,
    "daily_cap": 0,
    "approved": true,
    "launched_at": "2026-10-06T05:30:00.000Z",
    "last_run_on": "string",
    "spent_paise": 850000000,
    "summary": {
      "selected": 0,
      "treatment": 0,
      "holdout": 0,
      "pending": 0,
      "contacted": 0,
      "replied": 0,
      "requalified": 0,
      "handed_off": 0,
      "skipped": 0
    },
    "created_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "can": {
      "edit": true,
      "send": true,
      "delete": true
    },
    "config": {},
    "compliance": {
      "state": "missing",
      "status": "pass",
      "issues": [
        {
          "source": "rule",
          "category": "string",
          "severity": "block",
          "quote": "string",
          "message": "string",
          "rule_id": "string"
        }
      ],
      "ai_review": "done",
      "checked_at": "string",
      "override": {
        "by": "string",
        "at": "string",
        "reason": "string"
      }
    },
    "approved_at": "2026-10-06T05:30:00.000Z",
    "approved_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "launched_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "paused_at": "2026-10-06T05:30:00.000Z",
    "stopped_at": "2026-10-06T05:30:00.000Z",
    "ai_credits": 0,
    "pending_batch": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "run_on": "string",
      "status": "pending_approval",
      "first": true,
      "counts": {},
      "decided_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "decided_at": "2026-10-06T05:30:00.000Z",
      "decision_note": "string",
      "created_at": "2026-10-06T05:30:00.000Z"
    },
    "batches": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "run_on": "string",
        "status": "pending_approval",
        "first": true,
        "counts": {},
        "decided_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "decided_at": "2026-10-06T05:30:00.000Z",
        "decision_note": "string",
        "created_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/settings/reactivation

Re-activation settings

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

Response · 200

datarequired: ReactivationSettings
metarequired: object

Request

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

Response example

{
  "data": {
    "enabled": true,
    "email_basis": "consent",
    "cooldown_days": 30,
    "lifetime_cap": 1,
    "recent_contact_days": 7
  },
  "meta": {}
}

Errors

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

PUT/v1/settings/reactivation

Change the re-activation settings

The company switch, the email basis, the cool-down, the lifetime cap and the recent-contact window.

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

Request body

enabled: boolean
email_basis: "consent" | "legitimate_interest"
consent: an explicit email opt-in · legitimate_interest: also people whose consent ledger records a DPDP legitimate-use basis for email. Every email carries a one-click unsubscribe.
cooldown_days: integer
lifetime_cap: integer
recent_contact_days: integer

Response · 200

datarequired: ReactivationSettings
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/settings/reactivation' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"enabled":true,"email_basis":"consent","cooldown_days":30,"lifetime_cap":1,"recent_contact_days":7}'

Response example

{
  "data": {
    "enabled": true,
    "email_basis": "consent",
    "cooldown_days": 30,
    "lifetime_cap": 1,
    "recent_contact_days": 7
  },
  "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.