Messaging

Compliance-gated sending (WhatsApp, DLT SMS, email), message status, inbox conversations and sending identities.

GET/v1/conversations

Conversations

Most recent first (or oldest first with `sort=oldest`), within the caller’s inbox scope.

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

Parameters

cursorquery: string
Opaque cursor from the previous page (`meta.next_cursor`).
limitquery: integer
Page size, 1–200.
viewquery: "mine" | "unassigned" | "all"
channelquery: "whatsapp_cloud" | "whatsapp_web" | "sms" | "email" | "voice" | "in_app"
statusquery: string
contact_idquery: Id
Opaque record id.
lead_idquery: Id
Opaque record id.
archivedquery: string
qquery: string
A phone suffix (4+ digits), the contact’s name or words of the last message.
unreadquery: string
Only conversations with unread messages.
snoozedquery: string
true: only snoozed until later · false: only awake ones · absent: both.
labelquery: string
ai_labelquery: "needs_attention" | "site_visit" | "qualified" | "price_enquiry"
Only chats showing this AI signal.
unrepliedquery: string
Only conversations whose latest message is the customer’s (waiting for a reply).
sortquery: "newest" | "oldest"
newest: latest activity first · oldest: the longest-quiet first.

Response · 200

datarequired: array of Conversation
metarequired: PageMeta

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "channel": "string",
      "channel_account_id": "cmusrceel0000q7kaafxqi1om",
      "contact": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "address": "string"
      },
      "lead_id": "cmusrceel0000q7kaafxqi1om",
      "assignee_id": "cmusrceel0000q7kaafxqi1om",
      "status": "string",
      "labels": [
        "string"
      ],
      "unread_count": 0,
      "unread_for_me": true,
      "last_message_at": "2026-10-06T05:30:00.000Z",
      "last_inbound_at": "2026-10-06T05:30:00.000Z",
      "last_message_preview": "string",
      "window": {
        "open": true,
        "expires_at": "2026-10-06T05:30:00.000Z"
      },
      "is_archived": true,
      "is_pinned": true,
      "snoozed_until": "2026-10-06T05:30:00.000Z",
      "created_at": "2026-10-06T05:30:00.000Z",
      "can_note": true,
      "ai": {
        "label": "needs_attention",
        "state": "string",
        "intent": "string",
        "score": 0
      }
    }
  ],
  "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/conversations/options

Inbox options

Sending identities, team members and labels for the composer, filters and the details panel.

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

Response · 200

datarequired: InboxOptions
metarequired: object

Request

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

Response example

{
  "data": {
    "channels": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "whatsapp_cloud",
        "label": "string",
        "address": "string",
        "is_default": true
      }
    ],
    "members": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      }
    ],
    "labels": [
      "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.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/conversations/uploads

Upload URL for an attachment

A presigned PUT for one file (content type and exact size are signed): photos 5 MB, voice notes, audio and video 16 MB, PDFs 25 MB — WhatsApp’s media limits.

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

Request body

filenamerequired: string
content_typerequired: "image/jpeg" | "image/png" | "image/webp" | "video/mp4" | "video/3gpp" | "audio/ogg" | …
sizerequired: integer

Response · 200

datarequired: InboxUpload
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/conversations/uploads' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"filename":"string","content_type":"image/jpeg","size":1}'

Response example

{
  "data": {
    "key": "string",
    "url": "string",
    "method": "PUT",
    "headers": {},
    "expires_at": "2026-10-06T05:30:00.000Z",
    "kind": "image"
  },
  "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/conversations/{id}

A conversation

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: Conversation
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "channel": "string",
    "channel_account_id": "cmusrceel0000q7kaafxqi1om",
    "contact": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "address": "string"
    },
    "lead_id": "cmusrceel0000q7kaafxqi1om",
    "assignee_id": "cmusrceel0000q7kaafxqi1om",
    "status": "string",
    "labels": [
      "string"
    ],
    "unread_count": 0,
    "unread_for_me": true,
    "last_message_at": "2026-10-06T05:30:00.000Z",
    "last_inbound_at": "2026-10-06T05:30:00.000Z",
    "last_message_preview": "string",
    "window": {
      "open": true,
      "expires_at": "2026-10-06T05:30:00.000Z"
    },
    "is_archived": true,
    "is_pinned": true,
    "snoozed_until": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "can_note": true,
    "ai": {
      "label": "needs_attention",
      "state": "string",
      "intent": "string",
      "score": 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.

PATCH/v1/conversations/{id}

Label, snooze or close a conversation

For anyone who sees the conversation and may reply in it. Labels replace the current set.

Access: API key with messages:send, or a member session. Permission inbox.reply.

Parameters

idpathrequired: Id
Opaque record id.

Request body

labels: array of string
snoozed_until: DateTime or null
Hidden from the inbox views until then (at most 90 days ahead); null wakes it up.
archived: boolean
Done: moves it out of the inbox until the next message.

Response · 200

datarequired: Conversation
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/conversations/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"labels":["string"],"snoozed_until":"2026-10-06T05:30:00.000Z","archived":true}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "channel": "string",
    "channel_account_id": "cmusrceel0000q7kaafxqi1om",
    "contact": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "address": "string"
    },
    "lead_id": "cmusrceel0000q7kaafxqi1om",
    "assignee_id": "cmusrceel0000q7kaafxqi1om",
    "status": "string",
    "labels": [
      "string"
    ],
    "unread_count": 0,
    "unread_for_me": true,
    "last_message_at": "2026-10-06T05:30:00.000Z",
    "last_inbound_at": "2026-10-06T05:30:00.000Z",
    "last_message_preview": "string",
    "window": {
      "open": true,
      "expires_at": "2026-10-06T05:30:00.000Z"
    },
    "is_archived": true,
    "is_pinned": true,
    "snoozed_until": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "can_note": true,
    "ai": {
      "label": "needs_attention",
      "state": "string",
      "intent": "string",
      "score": 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.
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/conversations/{id}/assign

Assign a conversation

`assignee_id: null` unassigns.

Access: API key or member session. Permission inbox.assign.

Parameters

idpathrequired: Id
Opaque record id.

Request body

assignee_idrequired: Id or null
Opaque record id.

Response · 200

datarequired: Conversation
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/conversations/{id}/assign' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"assignee_id":"cmusrceel0000q7kaafxqi1om"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "channel": "string",
    "channel_account_id": "cmusrceel0000q7kaafxqi1om",
    "contact": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "address": "string"
    },
    "lead_id": "cmusrceel0000q7kaafxqi1om",
    "assignee_id": "cmusrceel0000q7kaafxqi1om",
    "status": "string",
    "labels": [
      "string"
    ],
    "unread_count": 0,
    "unread_for_me": true,
    "last_message_at": "2026-10-06T05:30:00.000Z",
    "last_inbound_at": "2026-10-06T05:30:00.000Z",
    "last_message_preview": "string",
    "window": {
      "open": true,
      "expires_at": "2026-10-06T05:30:00.000Z"
    },
    "is_archived": true,
    "is_pinned": true,
    "snoozed_until": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "can_note": true,
    "ai": {
      "label": "needs_attention",
      "state": "string",
      "intent": "string",
      "score": 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.
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/conversations/{id}/messages

Messages of a conversation

Newest first.

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

Parameters

idpathrequired: Id
Opaque record id.
cursorquery: string
Opaque cursor from the previous page (`meta.next_cursor`).
limitquery: integer
Page size, 1–200.

Response · 200

datarequired: array of Message
metarequired: PageMeta

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "conversation_id": "cmusrceel0000q7kaafxqi1om",
      "channel": "string",
      "direction": "inbound",
      "type": "string",
      "body": "string",
      "subject": "string",
      "media": [
        {
          "kind": "string",
          "mime": "string",
          "name": "string",
          "size": 0,
          "caption": "string",
          "voice": true,
          "url": "string",
          "expires_at": "2026-10-06T05:30:00.000Z",
          "scan": "pending"
        }
      ],
      "interactive": {
        "type": "buttons",
        "header": "string",
        "footer": "string",
        "buttons": [
          {
            "id": null,
            "title": null
          }
        ]
      },
      "status": "queued",
      "error": "string",
      "blocked_reason": "string",
      "purpose": "string",
      "to": "string",
      "template_id": "cmusrceel0000q7kaafxqi1om",
      "sent_by_id": "cmusrceel0000q7kaafxqi1om",
      "sent_by_ai": true,
      "automation_run_id": "string",
      "broadcast_id": "string",
      "reply_to_id": "string",
      "cost": 0,
      "created_at": "2026-10-06T05:30:00.000Z",
      "sent_at": "2026-10-06T05:30:00.000Z",
      "delivered_at": "2026-10-06T05:30:00.000Z",
      "read_at": "2026-10-06T05:30:00.000Z",
      "failed_at": "2026-10-06T05:30:00.000Z",
      "sender_verified": 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.
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/conversations/{id}/read

Mark a conversation read

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: Conversation
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "channel": "string",
    "channel_account_id": "cmusrceel0000q7kaafxqi1om",
    "contact": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "address": "string"
    },
    "lead_id": "cmusrceel0000q7kaafxqi1om",
    "assignee_id": "cmusrceel0000q7kaafxqi1om",
    "status": "string",
    "labels": [
      "string"
    ],
    "unread_count": 0,
    "unread_for_me": true,
    "last_message_at": "2026-10-06T05:30:00.000Z",
    "last_inbound_at": "2026-10-06T05:30:00.000Z",
    "last_message_preview": "string",
    "window": {
      "open": true,
      "expires_at": "2026-10-06T05:30:00.000Z"
    },
    "is_archived": true,
    "is_pinned": true,
    "snoozed_until": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "can_note": true,
    "ai": {
      "label": "needs_attention",
      "state": "string",
      "intent": "string",
      "score": 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/conversations/{id}/typing

Show “typing…” to a WhatsApp customer

WhatsApp Cloud threads inside the 24-hour window (INT-40): the customer sees “typing…” for up to 25 seconds or until the reply. It marks their latest message read, so nothing is sent while the company turned read receipts off. Queued, at most once per 20 seconds per conversation; other channels answer `sent: false`.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.sentrequired: boolean
True when the indicator was queued.
data.reasonrequired: "not_whatsapp_cloud" | "disabled" | "window_closed" | "no_inbound" or null
metarequired: object

Request

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

Response example

{
  "data": {
    "sent": true,
    "reason": "not_whatsapp_cloud"
  },
  "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/messages

Send a message

Runs the compliance gates, renders and queues one message (202), or answers 200 with `status: blocked` and the reasons. Never re-sends: the same `idempotency_key` returns the first result.

Access: API key with messages:send, or a member session. Permission inbox.reply.

Parameters

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

Request body

contact_id: Id
Opaque record id.
lead_id: Id
Opaque record id.
channel: "whatsapp_cloud" | "whatsapp_web" | "sms" | "email" | "auto"
purposerequired: MessagePurpose
transactional: OTPs, receipts (not subject to consent) · service: visit reminders, documents (unless opted out) · promotional: launches, matches, price drops (consent or the TRAI 7-day enquiry window, quiet hours, DND).
template_id: Id
Opaque record id.
template_use_case: string
e.g. visit_reminder_24h
language: string
body: string
media: SendMessageMedia
One photo, video, voice note or document; the body becomes its caption (not for voice notes).
interactive: object or object
Reply buttons (≤ 3, title ≤ 20) or a list (≤ 10 rows, title ≤ 24, description ≤ 72) under `body` — WhatsApp Cloud only, inside the 24-hour window; no template or media.
subject: string
vars: map of string
property_id: Id
Opaque record id.
project_id: Id
Opaque record id.
visit_id: Id
Opaque record id.
channel_account_id: Id
Opaque record id.
conversation_id: Id
The conversation being answered: a WhatsApp reply goes to its number and account.
reply_to_message_id: Id
Opaque record id.
when_quiet: "block" | "defer"
idempotency_keyrequired: string
Unique per logical send (a UUID): the same key never sends twice.

Response · 202

datarequired: SendMessageResult
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/messages' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"contact_id":"cmusrceel0000q7kaafxqi1om","lead_id":"cmusrceel0000q7kaafxqi1om","channel":"auto","purpose":"transactional","template_id":"cmusrceel0000q7kaafxqi1om","template_use_case":"string","language":"string","body":"string","media":{"storage_key":"string","url":"https://example.com","mime":"image/jpeg","filename":"string","size":0},"interactive":{"type":"buttons","header":"string","footer":"string","buttons":[{"id":"string","title":"string"}]},"subject":"string","vars":{},"property_id":"cmusrceel0000q7kaafxqi1om","project_id":"cmusrceel0000q7kaafxqi1om","visit_id":"cmusrceel0000q7kaafxqi1om","channel_account_id":"cmusrceel0000q7kaafxqi1om","conversation_id":"cmusrceel0000q7kaafxqi1om","reply_to_message_id":"cmusrceel0000q7kaafxqi1om","when_quiet":"block","idempotency_key":"string"}'

Response example

{
  "data": {
    "status": "queued",
    "message_id": "cmusrceel0000q7kaafxqi1om",
    "conversation_id": "cmusrceel0000q7kaafxqi1om",
    "channel": "whatsapp_cloud",
    "purpose": "transactional",
    "duplicate": true,
    "not_before": "2026-10-06T05:30:00.000Z",
    "cost": 0,
    "warnings": [
      "string"
    ],
    "preview": {
      "text": "string",
      "subject": "string",
      "html": "string",
      "sms": {
        "encoding": "gsm",
        "segments": 0
      }
    }
  },
  "meta": {}
}

Errors

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

GET/v1/messages/channels

Sending identities

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

Parameters

kindquery: "whatsapp_cloud" | "whatsapp_web" | "sms" | "email"

Response · 200

datarequired: array of ChannelAccount
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "kind": "string",
      "label": "string",
      "address": "string",
      "status": "string",
      "external_id": "string",
      "owner_member_id": "cmusrceel0000q7kaafxqi1om",
      "is_default": true,
      "details": {},
      "last_seen_at": "2026-10-06T05:30:00.000Z",
      "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.

GET/v1/messages/channels/dlt

DLT setup (SMS)

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

Response · 200

datarequired: DltSetup
metarequired: object

Request

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

Response example

{
  "data": {
    "configured": true,
    "entity_id": "string",
    "entity_name": "string",
    "provider": "msg91",
    "api": "flow",
    "has_auth_key": true,
    "webhook_configured": true,
    "headers": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "string",
        "label": "string",
        "address": "string",
        "status": "string",
        "external_id": "string",
        "owner_member_id": "cmusrceel0000q7kaafxqi1om",
        "is_default": true,
        "details": {},
        "last_seen_at": "2026-10-06T05:30:00.000Z",
        "created_at": "2026-10-06T05:30:00.000Z",
        "updated_at": "2026-10-06T05:30:00.000Z"
      }
    ]
  },
  "meta": {}
}

Errors

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

PUT/v1/messages/channels/dlt

Save the DLT setup

`auth_key`: a string stores the tenant’s MSG91 key (encrypted), null removes it, omitted keeps it.

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

Request body

entity_idrequired: string
entity_name: string or null
auth_key: string or null
api: "flow" | "sendsms"

Response · 200

datarequired: DltSetup
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/messages/channels/dlt' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"entity_id":"string","entity_name":"string","auth_key":"string","api":"flow"}'

Response example

{
  "data": {
    "configured": true,
    "entity_id": "string",
    "entity_name": "string",
    "provider": "msg91",
    "api": "flow",
    "has_auth_key": true,
    "webhook_configured": true,
    "headers": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "string",
        "label": "string",
        "address": "string",
        "status": "string",
        "external_id": "string",
        "owner_member_id": "cmusrceel0000q7kaafxqi1om",
        "is_default": true,
        "details": {},
        "last_seen_at": "2026-10-06T05:30:00.000Z",
        "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.

POST/v1/messages/channels/dlt/headers

Add an SMS header

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

Request body

headerrequired: string
categoryrequired: "transactional" | "service_implicit" | "service_explicit" | "promotional"
label: string or null
is_default: boolean

Response · 201

datarequired: ChannelAccount
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/messages/channels/dlt/headers' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"header":"string","category":"transactional","label":"string","is_default":true}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "kind": "string",
    "label": "string",
    "address": "string",
    "status": "string",
    "external_id": "string",
    "owner_member_id": "cmusrceel0000q7kaafxqi1om",
    "is_default": true,
    "details": {},
    "last_seen_at": "2026-10-06T05:30:00.000Z",
    "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.

POST/v1/messages/channels/dlt/webhook

New delivery-report webhook URL

Shown once: paste it into MSG91’s webhook settings. The previous URL stops working.

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

Response · 200

datarequired: object
data.urlrequired: string
data.inbound_urlrequired: string
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/messages/channels/dlt/webhook' \
  -H 'Authorization: Bearer pz_live_…'

Response example

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

POST/v1/messages/channels/email

Add an email sender

Generates a DKIM key; publish the DNS records, then verify the domain.

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

Request body

from_namerequired: string
from_emailrequired: string
reply_to: string or null
is_default: boolean

Response · 201

datarequired: ChannelAccount
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/messages/channels/email' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"from_name":"string","from_email":"string","reply_to":"string","is_default":true}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "kind": "string",
    "label": "string",
    "address": "string",
    "status": "string",
    "external_id": "string",
    "owner_member_id": "cmusrceel0000q7kaafxqi1om",
    "is_default": true,
    "details": {},
    "last_seen_at": "2026-10-06T05:30:00.000Z",
    "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.

PATCH/v1/messages/channels/{id}

Update an email sender

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

from_name: string
reply_to: string or null
is_default: boolean

Response · 200

datarequired: ChannelAccount
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/messages/channels/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"from_name":"string","reply_to":"string","is_default":true}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "kind": "string",
    "label": "string",
    "address": "string",
    "status": "string",
    "external_id": "string",
    "owner_member_id": "cmusrceel0000q7kaafxqi1om",
    "is_default": true,
    "details": {},
    "last_seen_at": "2026-10-06T05:30:00.000Z",
    "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/messages/channels/{id}

Disconnect a sender

Kept for history; it stops sending.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: ChannelAccount
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "kind": "string",
    "label": "string",
    "address": "string",
    "status": "string",
    "external_id": "string",
    "owner_member_id": "cmusrceel0000q7kaafxqi1om",
    "is_default": true,
    "details": {},
    "last_seen_at": "2026-10-06T05:30:00.000Z",
    "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/messages/channels/{id}/dns

DNS records of an email sender’s domain

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: array of DnsRecord
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "type": "TXT",
      "host": "string",
      "value": "string",
      "purpose": "spf",
      "required": true,
      "note": "string",
      "status": "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/messages/channels/{id}/verify

Check an email sender’s DNS records

With PropZolo’s email service (Resend) the check runs in the background: the answer carries the last known state, and the sender’s `details.resend.status` updates within minutes.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.accountrequired: ChannelAccount
data.checksrequired: array of object
data.checks[].recordrequired: DnsRecord
data.checks[].okrequired: boolean
data.checks[].foundrequired: array of string
metarequired: object

Request

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

Response example

{
  "data": {
    "account": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "kind": "string",
      "label": "string",
      "address": "string",
      "status": "string",
      "external_id": "string",
      "owner_member_id": "cmusrceel0000q7kaafxqi1om",
      "is_default": true,
      "details": {},
      "last_seen_at": "2026-10-06T05:30:00.000Z",
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z"
    },
    "checks": [
      {
        "record": {
          "type": "TXT",
          "host": "string",
          "value": "string",
          "purpose": "spf",
          "required": true,
          "note": "string",
          "status": "string"
        },
        "ok": true,
        "found": [
          "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/messages/check

Check a message before sending

The same gates and rendering as sending, without sending or recording anything.

Access: API key with messages:send, or a member session. Permission inbox.reply.

Request body

contact_id: Id
Opaque record id.
lead_id: Id
Opaque record id.
channel: "whatsapp_cloud" | "whatsapp_web" | "sms" | "email" | "auto"
purposerequired: MessagePurpose
transactional: OTPs, receipts (not subject to consent) · service: visit reminders, documents (unless opted out) · promotional: launches, matches, price drops (consent or the TRAI 7-day enquiry window, quiet hours, DND).
template_id: Id
Opaque record id.
template_use_case: string
e.g. visit_reminder_24h
language: string
body: string
media: SendMessageMedia
One photo, video, voice note or document; the body becomes its caption (not for voice notes).
interactive: object or object
Reply buttons (≤ 3, title ≤ 20) or a list (≤ 10 rows, title ≤ 24, description ≤ 72) under `body` — WhatsApp Cloud only, inside the 24-hour window; no template or media.
subject: string
vars: map of string
property_id: Id
Opaque record id.
project_id: Id
Opaque record id.
visit_id: Id
Opaque record id.
channel_account_id: Id
Opaque record id.
conversation_id: Id
The conversation being answered: a WhatsApp reply goes to its number and account.
reply_to_message_id: Id
Opaque record id.
when_quiet: "block" | "defer"

Response · 200

datarequired: CheckMessageResult
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/messages/check' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"contact_id":"cmusrceel0000q7kaafxqi1om","lead_id":"cmusrceel0000q7kaafxqi1om","channel":"auto","purpose":"transactional","template_id":"cmusrceel0000q7kaafxqi1om","template_use_case":"string","language":"string","body":"string","media":{"storage_key":"string","url":"https://example.com","mime":"image/jpeg","filename":"string","size":0},"interactive":{"type":"buttons","header":"string","footer":"string","buttons":[{"id":"string","title":"string"}]},"subject":"string","vars":{},"property_id":"cmusrceel0000q7kaafxqi1om","project_id":"cmusrceel0000q7kaafxqi1om","visit_id":"cmusrceel0000q7kaafxqi1om","channel_account_id":"cmusrceel0000q7kaafxqi1om","conversation_id":"cmusrceel0000q7kaafxqi1om","reply_to_message_id":"cmusrceel0000q7kaafxqi1om","when_quiet":"block"}'

Response example

{
  "data": {
    "status": "allowed",
    "channel": "whatsapp_cloud",
    "purpose": "transactional",
    "cost": 0,
    "warnings": [
      "string"
    ],
    "preview": {
      "text": "string",
      "subject": "string",
      "html": "string",
      "sms": {
        "encoding": "gsm",
        "segments": 0
      }
    },
    "not_before": "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.

PATCH/v1/messages/email/replies

Email reply capture settings

Whether a copy of each reply captured into the inbox also goes to the agent’s own email (audited).

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

Request body

forward_to_agentrequired: boolean

Response · 200

datarequired: EmailReplySettings
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/messages/email/replies' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"forward_to_agent":true}'

Response example

{
  "data": {
    "capture": true,
    "forward_to_agent": true
  },
  "meta": {}
}

Errors

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

GET/v1/messages/email/reputation

Email sending health

The last 7 days’ bounce and complaint rates, and whether promotional email is paused.

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

Response · 200

datarequired: EmailReputation
metarequired: object

Request

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

Response example

{
  "data": {
    "paused": true,
    "reason": "string",
    "pause_reason": "bounce_rate",
    "paused_at": "string",
    "resumed_at": "string",
    "checked_at": "string",
    "window_from": "string",
    "sent": 0,
    "bounces": 0,
    "complaints": 0,
    "bounce_rate": 0,
    "complaint_rate": 0,
    "limits": {
      "bounce_rate": 0,
      "complaint_rate": 0,
      "min_sent": 0
    },
    "sending_quota": {
      "day": "string",
      "used": 0,
      "cap": 0,
      "resets_at": "string",
      "warmup": [
        {
          "domain": "string",
          "day": 0,
          "days": 0,
          "cap": 0,
          "used": 0,
          "ends_at": "string"
        }
      ]
    },
    "replies": {
      "capture": true,
      "forward_to_agent": 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.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/messages/email/reputation/resume

Resume promotional email

Lifts a pause set by the reputation check (audited). The next check counts from now.

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

Response · 200

datarequired: EmailReputation
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/messages/email/reputation/resume' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "paused": true,
    "reason": "string",
    "pause_reason": "bounce_rate",
    "paused_at": "string",
    "resumed_at": "string",
    "checked_at": "string",
    "window_from": "string",
    "sent": 0,
    "bounces": 0,
    "complaints": 0,
    "bounce_rate": 0,
    "complaint_rate": 0,
    "limits": {
      "bounce_rate": 0,
      "complaint_rate": 0,
      "min_sent": 0
    },
    "sending_quota": {
      "day": "string",
      "used": 0,
      "cap": 0,
      "resets_at": "string",
      "warmup": [
        {
          "domain": "string",
          "day": 0,
          "days": 0,
          "cap": 0,
          "used": 0,
          "ends_at": "string"
        }
      ]
    },
    "replies": {
      "capture": true,
      "forward_to_agent": 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.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/messages/rules

Messaging rules

The compliance rules every send follows: pause, quiet hours, promotional SMS window, frequency caps.

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

Response · 200

datarequired: MessagingRules
metarequired: object

Request

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

Response example

{
  "data": {
    "kill_switch": {
      "paused": true,
      "channels": [
        "string"
      ],
      "reason": "string",
      "billing_hold": true
    },
    "quiet_hours": {
      "start": "string",
      "end": "string"
    },
    "quiet_hours_service": true,
    "sms_promotional_window": {
      "start": "string",
      "end": "string"
    },
    "frequency_caps": {
      "promotional": {
        "per_day": 1,
        "per_week": 1
      },
      "service": {
        "per_day": 1,
        "per_week": 1
      }
    },
    "channel_priority": [
      "whatsapp_cloud"
    ],
    "rera_footer": true,
    "email_tracking": {
      "opens": true,
      "clicks": 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.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/messages/rules

Change messaging rules

Only the fields sent change (audited). Quiet hours may be longer than 21:00–09:00, never shorter; the promotional SMS window may be narrower than 10:00–21:00, never wider (422 otherwise).

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

Request body

quiet_hours: object
quiet_hours.startrequired: string
quiet_hours.endrequired: string
quiet_hours_service: boolean
sms_promotional_window: object
sms_promotional_window.startrequired: string
sms_promotional_window.endrequired: string
frequency_caps: object
frequency_caps.promotionalrequired: object or null
frequency_caps.promotional.per_dayrequired: integer
frequency_caps.promotional.per_weekrequired: integer
frequency_caps.servicerequired: object or null
frequency_caps.service.per_dayrequired: integer
frequency_caps.service.per_weekrequired: integer
channel_priority: array of "whatsapp_cloud" | "sms" | "email"
rera_footer: boolean
email_tracking: object
email_tracking.opensrequired: boolean
email_tracking.clicksrequired: boolean

Response · 200

datarequired: MessagingRules
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/messages/rules' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"quiet_hours":{"start":"string","end":"string"},"quiet_hours_service":true,"sms_promotional_window":{"start":"string","end":"string"},"frequency_caps":{"promotional":{"per_day":1,"per_week":1},"service":{"per_day":1,"per_week":1}},"channel_priority":["whatsapp_cloud"],"rera_footer":true,"email_tracking":{"opens":true,"clicks":true}}'

Response example

{
  "data": {
    "kill_switch": {
      "paused": true,
      "channels": [
        "string"
      ],
      "reason": "string",
      "billing_hold": true
    },
    "quiet_hours": {
      "start": "string",
      "end": "string"
    },
    "quiet_hours_service": true,
    "sms_promotional_window": {
      "start": "string",
      "end": "string"
    },
    "frequency_caps": {
      "promotional": {
        "per_day": 1,
        "per_week": 1
      },
      "service": {
        "per_day": 1,
        "per_week": 1
      }
    },
    "channel_priority": [
      "whatsapp_cloud"
    ],
    "rera_footer": true,
    "email_tracking": {
      "opens": true,
      "clicks": true
    }
  },
  "meta": {}
}

Errors

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

PUT/v1/messages/rules/pause

Pause or resume customer messaging

Stops every customer message (or the listed channels) until resumed; a reason is required to pause. Needs step-up. A billing hold cannot be lifted here (403).

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

Request body

pausedrequired: boolean
channels: array of "whatsapp_cloud" | "whatsapp_web" | "sms" | "email"
reason: string or null

Response · 200

datarequired: MessagingRules
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/messages/rules/pause' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"paused":true,"channels":[],"reason":"string"}'

Response example

{
  "data": {
    "kill_switch": {
      "paused": true,
      "channels": [
        "string"
      ],
      "reason": "string",
      "billing_hold": true
    },
    "quiet_hours": {
      "start": "string",
      "end": "string"
    },
    "quiet_hours_service": true,
    "sms_promotional_window": {
      "start": "string",
      "end": "string"
    },
    "frequency_caps": {
      "promotional": {
        "per_day": 1,
        "per_week": 1
      },
      "service": {
        "per_day": 1,
        "per_week": 1
      }
    },
    "channel_priority": [
      "whatsapp_cloud"
    ],
    "rera_footer": true,
    "email_tracking": {
      "opens": true,
      "clicks": true
    }
  },
  "meta": {}
}

Errors

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

GET/v1/messages/{id}

A message and its delivery status

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: Message
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "conversation_id": "cmusrceel0000q7kaafxqi1om",
    "channel": "string",
    "direction": "inbound",
    "type": "string",
    "body": "string",
    "subject": "string",
    "media": [
      {
        "kind": "string",
        "mime": "string",
        "name": "string",
        "size": 0,
        "caption": "string",
        "voice": true,
        "url": "string",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "scan": "pending"
      }
    ],
    "interactive": {
      "type": "buttons",
      "header": "string",
      "footer": "string",
      "buttons": [
        {
          "id": "string",
          "title": "string"
        }
      ]
    },
    "status": "queued",
    "error": "string",
    "blocked_reason": "string",
    "purpose": "string",
    "to": "string",
    "template_id": "cmusrceel0000q7kaafxqi1om",
    "sent_by_id": "cmusrceel0000q7kaafxqi1om",
    "sent_by_ai": true,
    "automation_run_id": "string",
    "broadcast_id": "string",
    "reply_to_id": "string",
    "cost": 0,
    "created_at": "2026-10-06T05:30:00.000Z",
    "sent_at": "2026-10-06T05:30:00.000Z",
    "delivered_at": "2026-10-06T05:30:00.000Z",
    "read_at": "2026-10-06T05:30:00.000Z",
    "failed_at": "2026-10-06T05:30:00.000Z",
    "sender_verified": 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/quick-replies

Quick replies

The caller’s personal quick replies and the shared ones, by shortcut (a small list: no pagination).

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

Parameters

qquery: string

Response · 200

datarequired: array of QuickReply
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "shortcut": "string",
      "title": "string",
      "body": "string",
      "shared": true,
      "owner_id": "cmusrceel0000q7kaafxqi1om",
      "usage_count": 0,
      "can_edit": true,
      "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/quick-replies

Add a quick reply

`shared: true` makes it the team’s (needs `templates.edit`). A shortcut is unique per owner (409).

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

Request body

shortcutrequired: string
Typed after "/" in the composer; a leading "/" is dropped and letters are lower-cased.
titlerequired: string
bodyrequired: string
shared: boolean

Response · 201

datarequired: QuickReply
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/quick-replies' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"shortcut":"string","title":"string","body":"string","shared":false}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "shortcut": "string",
    "title": "string",
    "body": "string",
    "shared": true,
    "owner_id": "cmusrceel0000q7kaafxqi1om",
    "usage_count": 0,
    "can_edit": true,
    "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.

PATCH/v1/quick-replies/{id}

Edit a quick reply

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

shortcut: string
Typed after "/" in the composer; a leading "/" is dropped and letters are lower-cased.
title: string
body: string

Response · 200

datarequired: QuickReply
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/quick-replies/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"shortcut":"string","title":"string","body":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "shortcut": "string",
    "title": "string",
    "body": "string",
    "shared": true,
    "owner_id": "cmusrceel0000q7kaafxqi1om",
    "usage_count": 0,
    "can_edit": true,
    "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/quick-replies/{id}

Delete a quick reply

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.deletedrequired: true
metarequired: object

Request

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

Response example

{
  "data": {
    "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.