Follow-up agent

Goal-based follow-up on a lead (book a visit, collect documents, get a decision, revive): AI drafts each touch within the company’s rules, the owner approves, edits or rejects it (autopilot only where allowed), every send goes through the messaging gates and a reply, an opt-out or the goal being met hands the lead back.

GET/v1/followup-approvals

Drafts waiting for approval

`mine`: drafts of your goals; `all` (reviewers): every draft of the leads you can see. Oldest first; keyset pagination.

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

Parameters

scopequery: "mine" | "all"
cursorquery: Id
Opaque record id.
limitquery: integer

Response · 200

datarequired: array of FollowupApproval
metarequired: PageMeta

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "goal_id": "cmusrceel0000q7kaafxqi1om",
      "lead_id": "cmusrceel0000q7kaafxqi1om",
      "seq": 0,
      "channel": "whatsapp_cloud",
      "status": "drafting",
      "planned_at": "2026-10-06T05:30:00.000Z",
      "text": "string",
      "draft_text": "string",
      "edited": true,
      "language": "string",
      "ai_status": "string",
      "ai_note": "string",
      "auto": true,
      "decided_by_id": "cmusrceel0000q7kaafxqi1om",
      "decided_at": "2026-10-06T05:30:00.000Z",
      "decision_note": "string",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "message_id": "cmusrceel0000q7kaafxqi1om",
      "task_id": "cmusrceel0000q7kaafxqi1om",
      "block_reason": "string",
      "cost_paise": 850000000,
      "sent_at": "2026-10-06T05:30:00.000Z",
      "created_at": "2026-10-06T05:30:00.000Z",
      "goal": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "site_visit",
        "label": "string",
        "mode": "cowork",
        "owner_id": "cmusrceel0000q7kaafxqi1om",
        "touches": 0,
        "max_touches": 0,
        "deadline_at": "2026-10-06T05:30:00.000Z",
        "instructions": "string"
      },
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "name": "string"
      },
      "template": {
        "text": "string",
        "problems": [
          "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.
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/followup-approvals/{id}/approve

Approve (or edit and approve) a draft

Sent through the messaging pipeline at once (its gates apply again; outside quiet hours it waits in the queue). The goal’s owner or a reviewer decides; an expired draft cannot be approved (409).

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

text: string

Response · 200

datarequired: FollowupApproval
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "goal_id": "cmusrceel0000q7kaafxqi1om",
    "lead_id": "cmusrceel0000q7kaafxqi1om",
    "seq": 0,
    "channel": "whatsapp_cloud",
    "status": "drafting",
    "planned_at": "2026-10-06T05:30:00.000Z",
    "text": "string",
    "draft_text": "string",
    "edited": true,
    "language": "string",
    "ai_status": "string",
    "ai_note": "string",
    "auto": true,
    "decided_by_id": "cmusrceel0000q7kaafxqi1om",
    "decided_at": "2026-10-06T05:30:00.000Z",
    "decision_note": "string",
    "expires_at": "2026-10-06T05:30:00.000Z",
    "message_id": "cmusrceel0000q7kaafxqi1om",
    "task_id": "cmusrceel0000q7kaafxqi1om",
    "block_reason": "string",
    "cost_paise": 850000000,
    "sent_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "goal": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "kind": "site_visit",
      "label": "string",
      "mode": "cowork",
      "owner_id": "cmusrceel0000q7kaafxqi1om",
      "touches": 0,
      "max_touches": 0,
      "deadline_at": "2026-10-06T05:30:00.000Z",
      "instructions": "string"
    },
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "name": "string"
    },
    "template": {
      "text": "string",
      "problems": [
        "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/followup-approvals/{id}/reject

Reject a draft

The agent drafts again after the cool-down, told what was wrong.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

note: string

Response · 200

datarequired: FollowupApproval
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "goal_id": "cmusrceel0000q7kaafxqi1om",
    "lead_id": "cmusrceel0000q7kaafxqi1om",
    "seq": 0,
    "channel": "whatsapp_cloud",
    "status": "drafting",
    "planned_at": "2026-10-06T05:30:00.000Z",
    "text": "string",
    "draft_text": "string",
    "edited": true,
    "language": "string",
    "ai_status": "string",
    "ai_note": "string",
    "auto": true,
    "decided_by_id": "cmusrceel0000q7kaafxqi1om",
    "decided_at": "2026-10-06T05:30:00.000Z",
    "decision_note": "string",
    "expires_at": "2026-10-06T05:30:00.000Z",
    "message_id": "cmusrceel0000q7kaafxqi1om",
    "task_id": "cmusrceel0000q7kaafxqi1om",
    "block_reason": "string",
    "cost_paise": 850000000,
    "sent_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "goal": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "kind": "site_visit",
      "label": "string",
      "mode": "cowork",
      "owner_id": "cmusrceel0000q7kaafxqi1om",
      "touches": 0,
      "max_touches": 0,
      "deadline_at": "2026-10-06T05:30:00.000Z",
      "instructions": "string"
    },
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "name": "string"
    },
    "template": {
      "text": "string",
      "problems": [
        "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.

GET/v1/followup-goals/{id}

A follow-up goal

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: FollowupGoal
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "lead_id": "cmusrceel0000q7kaafxqi1om",
    "kind": "site_visit",
    "label": "string",
    "status": "active",
    "mode": "cowork",
    "owner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "source": "member",
    "instructions": "string",
    "documents": [
      "string"
    ],
    "channels": [
      "whatsapp_cloud"
    ],
    "max_touches": 0,
    "touches": 0,
    "deadline_at": "2026-10-06T05:30:00.000Z",
    "next_step_at": "2026-10-06T05:30:00.000Z",
    "last_touch_at": "2026-10-06T05:30:00.000Z",
    "stop_reason": "string",
    "stop_detail": "string",
    "met_at": "2026-10-06T05:30:00.000Z",
    "stopped_at": "2026-10-06T05:30:00.000Z",
    "handoff_task_id": "cmusrceel0000q7kaafxqi1om",
    "ai_credits": 0,
    "cost_paise": 850000000,
    "created_by_id": "cmusrceel0000q7kaafxqi1om",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "steps": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "goal_id": "cmusrceel0000q7kaafxqi1om",
        "lead_id": "cmusrceel0000q7kaafxqi1om",
        "seq": 0,
        "channel": "whatsapp_cloud",
        "status": "drafting",
        "planned_at": "2026-10-06T05:30:00.000Z",
        "text": "string",
        "draft_text": "string",
        "edited": true,
        "language": "string",
        "ai_status": "string",
        "ai_note": "string",
        "auto": true,
        "decided_by_id": "cmusrceel0000q7kaafxqi1om",
        "decided_at": "2026-10-06T05:30:00.000Z",
        "decision_note": "string",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "message_id": "cmusrceel0000q7kaafxqi1om",
        "task_id": "cmusrceel0000q7kaafxqi1om",
        "block_reason": "string",
        "cost_paise": 850000000,
        "sent_at": "2026-10-06T05:30:00.000Z",
        "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/followup-goals/{id}/actions

Pause, resume, stop or mark a goal met

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

actionrequired: "pause" | "resume" | "stop" | "met"
note: string

Response · 200

datarequired: FollowupGoal
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/followup-goals/{id}/actions' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"action":"pause","note":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "lead_id": "cmusrceel0000q7kaafxqi1om",
    "kind": "site_visit",
    "label": "string",
    "status": "active",
    "mode": "cowork",
    "owner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "source": "member",
    "instructions": "string",
    "documents": [
      "string"
    ],
    "channels": [
      "whatsapp_cloud"
    ],
    "max_touches": 0,
    "touches": 0,
    "deadline_at": "2026-10-06T05:30:00.000Z",
    "next_step_at": "2026-10-06T05:30:00.000Z",
    "last_touch_at": "2026-10-06T05:30:00.000Z",
    "stop_reason": "string",
    "stop_detail": "string",
    "met_at": "2026-10-06T05:30:00.000Z",
    "stopped_at": "2026-10-06T05:30:00.000Z",
    "handoff_task_id": "cmusrceel0000q7kaafxqi1om",
    "ai_credits": 0,
    "cost_paise": 850000000,
    "created_by_id": "cmusrceel0000q7kaafxqi1om",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "steps": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "goal_id": "cmusrceel0000q7kaafxqi1om",
        "lead_id": "cmusrceel0000q7kaafxqi1om",
        "seq": 0,
        "channel": "whatsapp_cloud",
        "status": "drafting",
        "planned_at": "2026-10-06T05:30:00.000Z",
        "text": "string",
        "draft_text": "string",
        "edited": true,
        "language": "string",
        "ai_status": "string",
        "ai_note": "string",
        "auto": true,
        "decided_by_id": "cmusrceel0000q7kaafxqi1om",
        "decided_at": "2026-10-06T05:30:00.000Z",
        "decision_note": "string",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "message_id": "cmusrceel0000q7kaafxqi1om",
        "task_id": "cmusrceel0000q7kaafxqi1om",
        "block_reason": "string",
        "cost_paise": 850000000,
        "sent_at": "2026-10-06T05:30:00.000Z",
        "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/followup-goals/{id}/documents

Mark documents received

A documents goal is met when the last pending document is received.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

receivedrequired: array of string

Response · 200

datarequired: FollowupGoal
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/followup-goals/{id}/documents' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"received":["string"]}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "lead_id": "cmusrceel0000q7kaafxqi1om",
    "kind": "site_visit",
    "label": "string",
    "status": "active",
    "mode": "cowork",
    "owner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "source": "member",
    "instructions": "string",
    "documents": [
      "string"
    ],
    "channels": [
      "whatsapp_cloud"
    ],
    "max_touches": 0,
    "touches": 0,
    "deadline_at": "2026-10-06T05:30:00.000Z",
    "next_step_at": "2026-10-06T05:30:00.000Z",
    "last_touch_at": "2026-10-06T05:30:00.000Z",
    "stop_reason": "string",
    "stop_detail": "string",
    "met_at": "2026-10-06T05:30:00.000Z",
    "stopped_at": "2026-10-06T05:30:00.000Z",
    "handoff_task_id": "cmusrceel0000q7kaafxqi1om",
    "ai_credits": 0,
    "cost_paise": 850000000,
    "created_by_id": "cmusrceel0000q7kaafxqi1om",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "steps": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "goal_id": "cmusrceel0000q7kaafxqi1om",
        "lead_id": "cmusrceel0000q7kaafxqi1om",
        "seq": 0,
        "channel": "whatsapp_cloud",
        "status": "drafting",
        "planned_at": "2026-10-06T05:30:00.000Z",
        "text": "string",
        "draft_text": "string",
        "edited": true,
        "language": "string",
        "ai_status": "string",
        "ai_note": "string",
        "auto": true,
        "decided_by_id": "cmusrceel0000q7kaafxqi1om",
        "decided_at": "2026-10-06T05:30:00.000Z",
        "decision_note": "string",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "message_id": "cmusrceel0000q7kaafxqi1om",
        "task_id": "cmusrceel0000q7kaafxqi1om",
        "block_reason": "string",
        "cost_paise": 850000000,
        "sent_at": "2026-10-06T05:30:00.000Z",
        "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/leads/{id}/followup-goals

Follow-up goals of a lead

Newest first, with every touch (drafts, approvals, sends, call tasks).

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: array of FollowupGoal
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "lead_id": "cmusrceel0000q7kaafxqi1om",
      "kind": "site_visit",
      "label": "string",
      "status": "active",
      "mode": "cowork",
      "owner": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "source": "member",
      "instructions": "string",
      "documents": [
        "string"
      ],
      "channels": [
        "whatsapp_cloud"
      ],
      "max_touches": 0,
      "touches": 0,
      "deadline_at": "2026-10-06T05:30:00.000Z",
      "next_step_at": "2026-10-06T05:30:00.000Z",
      "last_touch_at": "2026-10-06T05:30:00.000Z",
      "stop_reason": "string",
      "stop_detail": "string",
      "met_at": "2026-10-06T05:30:00.000Z",
      "stopped_at": "2026-10-06T05:30:00.000Z",
      "handoff_task_id": "cmusrceel0000q7kaafxqi1om",
      "ai_credits": 0,
      "cost_paise": 850000000,
      "created_by_id": "cmusrceel0000q7kaafxqi1om",
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z",
      "steps": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "goal_id": "cmusrceel0000q7kaafxqi1om",
          "lead_id": "cmusrceel0000q7kaafxqi1om",
          "seq": 0,
          "channel": "whatsapp_cloud",
          "status": "drafting",
          "planned_at": "2026-10-06T05:30:00.000Z",
          "text": "string",
          "draft_text": "string",
          "edited": true,
          "language": "string",
          "ai_status": "string",
          "ai_note": "string",
          "auto": true,
          "decided_by_id": "cmusrceel0000q7kaafxqi1om",
          "decided_at": "2026-10-06T05:30:00.000Z",
          "decision_note": "string",
          "expires_at": "2026-10-06T05:30:00.000Z",
          "message_id": "cmusrceel0000q7kaafxqi1om",
          "task_id": "cmusrceel0000q7kaafxqi1om",
          "block_reason": "string",
          "cost_paise": 850000000,
          "sent_at": "2026-10-06T05:30:00.000Z",
          "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/leads/{id}/followup-goals

Set a follow-up goal on a lead

One live goal per lead (409 otherwise). Channels and touches are kept within the company’s rules; autopilot only where the company allows it for this kind of goal. Needs edit access to the lead.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

kindrequired: "site_visit" | "documents" | "decision" | "revive"
mode: "cowork" | "autopilot"
channels: array of "whatsapp_cloud" | "sms" | "email" | "call_task"
max_touches: integer
deadline_days: integer
instructions: string
Your brief to the agent; never a price the CRM lacks.
documents: array of string

Response · 201

datarequired: FollowupGoal
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/leads/{id}/followup-goals' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"kind":"site_visit","mode":"cowork","channels":["whatsapp_cloud"],"max_touches":1,"deadline_days":1,"instructions":"string","documents":[]}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "lead_id": "cmusrceel0000q7kaafxqi1om",
    "kind": "site_visit",
    "label": "string",
    "status": "active",
    "mode": "cowork",
    "owner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "source": "member",
    "instructions": "string",
    "documents": [
      "string"
    ],
    "channels": [
      "whatsapp_cloud"
    ],
    "max_touches": 0,
    "touches": 0,
    "deadline_at": "2026-10-06T05:30:00.000Z",
    "next_step_at": "2026-10-06T05:30:00.000Z",
    "last_touch_at": "2026-10-06T05:30:00.000Z",
    "stop_reason": "string",
    "stop_detail": "string",
    "met_at": "2026-10-06T05:30:00.000Z",
    "stopped_at": "2026-10-06T05:30:00.000Z",
    "handoff_task_id": "cmusrceel0000q7kaafxqi1om",
    "ai_credits": 0,
    "cost_paise": 850000000,
    "created_by_id": "cmusrceel0000q7kaafxqi1om",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "steps": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "goal_id": "cmusrceel0000q7kaafxqi1om",
        "lead_id": "cmusrceel0000q7kaafxqi1om",
        "seq": 0,
        "channel": "whatsapp_cloud",
        "status": "drafting",
        "planned_at": "2026-10-06T05:30:00.000Z",
        "text": "string",
        "draft_text": "string",
        "edited": true,
        "language": "string",
        "ai_status": "string",
        "ai_note": "string",
        "auto": true,
        "decided_by_id": "cmusrceel0000q7kaafxqi1om",
        "decided_at": "2026-10-06T05:30:00.000Z",
        "decision_note": "string",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "message_id": "cmusrceel0000q7kaafxqi1om",
        "task_id": "cmusrceel0000q7kaafxqi1om",
        "block_reason": "string",
        "cost_paise": 850000000,
        "sent_at": "2026-10-06T05:30:00.000Z",
        "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/settings/followup-agent

Follow-up agent settings

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

Response · 200

datarequired: FollowupAgentSettings
metarequired: object

Request

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

Response example

{
  "data": {
    "enabled": true,
    "channels": [
      "whatsapp_cloud"
    ],
    "autopilot_allowed": true,
    "autopilot_goals": [
      "site_visit"
    ],
    "window": {
      "start": "string",
      "end": "string"
    },
    "working_days": [
      1
    ],
    "cool_down_hours": 12,
    "max_touches": 1,
    "default_deadline_days": 1,
    "approval_ttl_hours": 1,
    "call_after": 1,
    "templates": {
      "whatsapp_cloud": "cmusrceel0000q7kaafxqi1om",
      "sms": "cmusrceel0000q7kaafxqi1om"
    }
  },
  "meta": {}
}

Errors

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

PUT/v1/settings/followup-agent

Change the follow-up agent settings

The switch, channels, autopilot (per kind of goal), sending window and days, cool-down, max touches, deadline, approval window, when a call task replaces messages, and the approved templates used outside the free-text window.

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

Request body

enabled: boolean
channels: array of "whatsapp_cloud" | "sms" | "email" | "call_task"
autopilot_allowed: boolean
autopilot_goals: array of "site_visit" | "documents" | "decision" | "revive"
window: object
Sending hours, company clock (09:00–21:00 at most).
window.startrequired: string
window.endrequired: string
working_days: array of integer
1 = Monday … 7 = Sunday.
cool_down_hours: integer
max_touches: integer
default_deadline_days: integer
approval_ttl_hours: integer
call_after: integer
templates: object
templates.whatsapp_cloudrequired: Id or null
Opaque record id.
templates.smsrequired: Id or null
Opaque record id.

Response · 200

datarequired: FollowupAgentSettings
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/settings/followup-agent' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"enabled":true,"channels":["whatsapp_cloud"],"autopilot_allowed":true,"autopilot_goals":["site_visit"],"window":{"start":"string","end":"string"},"working_days":[1],"cool_down_hours":12,"max_touches":1,"default_deadline_days":1,"approval_ttl_hours":1,"call_after":1,"templates":{"whatsapp_cloud":"cmusrceel0000q7kaafxqi1om","sms":"cmusrceel0000q7kaafxqi1om"}}'

Response example

{
  "data": {
    "enabled": true,
    "channels": [
      "whatsapp_cloud"
    ],
    "autopilot_allowed": true,
    "autopilot_goals": [
      "site_visit"
    ],
    "window": {
      "start": "string",
      "end": "string"
    },
    "working_days": [
      1
    ],
    "cool_down_hours": 12,
    "max_touches": 1,
    "default_deadline_days": 1,
    "approval_ttl_hours": 1,
    "call_after": 1,
    "templates": {
      "whatsapp_cloud": "cmusrceel0000q7kaafxqi1om",
      "sms": "cmusrceel0000q7kaafxqi1om"
    }
  },
  "meta": {}
}

Errors

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

Follow-up agent

{ "data": [ { "id": "cmusrceel0000q7kaafxqi1om", "goal_id": "cmusrceel0000q7kaafxqi1om", "lead_id": "cmusrceel0000q7kaafxqi1om", "seq": 0, "channel": "whatsapp_cloud", "status": "drafting", "planned_at": "2026-10-06T05:30:00.000Z", "text": "string", "draft_text": "string", "edited": true, "language": "string", "ai_status": "string", "ai_note": "string", "auto": true, "decided_by_id": "cmusrceel0000q7kaafxqi1om", "decided_at": "2026-10-06T05:30:00.000Z", "decision_note": "string", "expires_at": "2026-10-06T05:30:00.000Z", "message_id": "cmusrceel0000q7kaafxqi1om", "task_id": "cmusrceel0000q7kaafxqi1om", "block_reason": "string", "cost_paise": 850000000, "sent_at": "2026-10-06T05:30:00.000Z", "created_at": "2026-10-06T05:30:00.000Z", "goal": { "id": "cmusrceel0000q7kaafxqi1om", "kind": "site_visit", "label": "string", "mode": "cowork", "owner_id": "cmusrceel0000q7kaafxqi1om", "touches": 0, "max_touches": 0, "deadline_at": "2026-10-06T05:30:00.000Z", "instructions": "string" }, "lead": { "id": "cmusrceel0000q7kaafxqi1om", "ref": "string", "name": "string" }, "template": { "text": "string", "problems": [ "string" ] } } ], "meta": { "next_cursor": "string", "has_more": true } }

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "goal_id": "cmusrceel0000q7kaafxqi1om", "lead_id": "cmusrceel0000q7kaafxqi1om", "seq": 0, "channel": "whatsapp_cloud", "status": "drafting", "planned_at": "2026-10-06T05:30:00.000Z", "text": "string", "draft_text": "string", "edited": true, "language": "string", "ai_status": "string", "ai_note": "string", "auto": true, "decided_by_id": "cmusrceel0000q7kaafxqi1om", "decided_at": "2026-10-06T05:30:00.000Z", "decision_note": "string", "expires_at": "2026-10-06T05:30:00.000Z", "message_id": "cmusrceel0000q7kaafxqi1om", "task_id": "cmusrceel0000q7kaafxqi1om", "block_reason": "string", "cost_paise": 850000000, "sent_at": "2026-10-06T05:30:00.000Z", "created_at": "2026-10-06T05:30:00.000Z", "goal": { "id": "cmusrceel0000q7kaafxqi1om", "kind": "site_visit", "label": "string", "mode": "cowork", "owner_id": "cmusrceel0000q7kaafxqi1om", "touches": 0, "max_touches": 0, "deadline_at": "2026-10-06T05:30:00.000Z", "instructions": "string" }, "lead": { "id": "cmusrceel0000q7kaafxqi1om", "ref": "string", "name": "string" }, "template": { "text": "string", "problems": [ "string" ] } }, "meta": {} }

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "lead_id": "cmusrceel0000q7kaafxqi1om", "kind": "site_visit", "label": "string", "status": "active", "mode": "cowork", "owner": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "source": "member", "instructions": "string", "documents": [ "string" ], "channels": [ "whatsapp_cloud" ], "max_touches": 0, "touches": 0, "deadline_at": "2026-10-06T05:30:00.000Z", "next_step_at": "2026-10-06T05:30:00.000Z", "last_touch_at": "2026-10-06T05:30:00.000Z", "stop_reason": "string", "stop_detail": "string", "met_at": "2026-10-06T05:30:00.000Z", "stopped_at": "2026-10-06T05:30:00.000Z", "handoff_task_id": "cmusrceel0000q7kaafxqi1om", "ai_credits": 0, "cost_paise": 850000000, "created_by_id": "cmusrceel0000q7kaafxqi1om", "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z", "steps": [ { "id": "cmusrceel0000q7kaafxqi1om", "goal_id": "cmusrceel0000q7kaafxqi1om", "lead_id": "cmusrceel0000q7kaafxqi1om", "seq": 0, "channel": "whatsapp_cloud", "status": "drafting", "planned_at": "2026-10-06T05:30:00.000Z", "text": "string", "draft_text": "string", "edited": true, "language": "string", "ai_status": "string", "ai_note": "string", "auto": true, "decided_by_id": "cmusrceel0000q7kaafxqi1om", "decided_at": "2026-10-06T05:30:00.000Z", "decision_note": "string", "expires_at": "2026-10-06T05:30:00.000Z", "message_id": "cmusrceel0000q7kaafxqi1om", "task_id": "cmusrceel0000q7kaafxqi1om", "block_reason": "string", "cost_paise": 850000000, "sent_at": "2026-10-06T05:30:00.000Z", "created_at": "2026-10-06T05:30:00.000Z" } ] }, "meta": {} }

{ "data": [ { "id": "cmusrceel0000q7kaafxqi1om", "lead_id": "cmusrceel0000q7kaafxqi1om", "kind": "site_visit", "label": "string", "status": "active", "mode": "cowork", "owner": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "source": "member", "instructions": "string", "documents": [ "string" ], "channels": [ "whatsapp_cloud" ], "max_touches": 0, "touches": 0, "deadline_at": "2026-10-06T05:30:00.000Z", "next_step_at": "2026-10-06T05:30:00.000Z", "last_touch_at": "2026-10-06T05:30:00.000Z", "stop_reason": "string", "stop_detail": "string", "met_at": "2026-10-06T05:30:00.000Z", "stopped_at": "2026-10-06T05:30:00.000Z", "handoff_task_id": "cmusrceel0000q7kaafxqi1om", "ai_credits": 0, "cost_paise": 850000000, "created_by_id": "cmusrceel0000q7kaafxqi1om", "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z", "steps": [ { "id": "cmusrceel0000q7kaafxqi1om", "goal_id": "cmusrceel0000q7kaafxqi1om", "lead_id": "cmusrceel0000q7kaafxqi1om", "seq": 0, "channel": "whatsapp_cloud", "status": "drafting", "planned_at": "2026-10-06T05:30:00.000Z", "text": "string", "draft_text": "string", "edited": true, "language": "string", "ai_status": "string", "ai_note": "string", "auto": true, "decided_by_id": "cmusrceel0000q7kaafxqi1om", "decided_at": "2026-10-06T05:30:00.000Z", "decision_note": "string", "expires_at": "2026-10-06T05:30:00.000Z", "message_id": "cmusrceel0000q7kaafxqi1om", "task_id": "cmusrceel0000q7kaafxqi1om", "block_reason": "string", "cost_paise": 850000000, "sent_at": "2026-10-06T05:30:00.000Z", "created_at": "2026-10-06T05:30:00.000Z" } ] } ], "meta": {} }

curl -X POST 'https://api.propzolo.com/v1/leads/{id}/followup-goals' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"kind":"site_visit","mode":"cowork","channels":["whatsapp_cloud"],"max_touches":1,"deadline_days":1,"instructions":"string","documents":[]}'

{ "data": { "enabled": true, "channels": [ "whatsapp_cloud" ], "autopilot_allowed": true, "autopilot_goals": [ "site_visit" ], "window": { "start": "string", "end": "string" }, "working_days": [ 1 ], "cool_down_hours": 12, "max_touches": 1, "default_deadline_days": 1, "approval_ttl_hours": 1, "call_after": 1, "templates": { "whatsapp_cloud": "cmusrceel0000q7kaafxqi1om", "sms": "cmusrceel0000q7kaafxqi1om" } }, "meta": {} }

curl -X PUT 'https://api.propzolo.com/v1/settings/followup-agent' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"enabled":true,"channels":["whatsapp_cloud"],"autopilot_allowed":true,"autopilot_goals":["site_visit"],"window":{"start":"string","end":"string"},"working_days":[1],"cool_down_hours":12,"max_touches":1,"default_deadline_days":1,"approval_ttl_hours":1,"call_after":1,"templates":{"whatsapp_cloud":"cmusrceel0000q7kaafxqi1om","sms":"cmusrceel0000q7kaafxqi1om"}}'