WhatsApp — PropZolo API

← All areas

WhatsApp Cloud API: connect with your own credentials or Embedded Signup, numbers with quality and tier, templates with Meta.

POST/v1/whatsapp/assisted

Open a WhatsApp draft on the phone (wa.me)

Builds the wa.me link for a lead, a contact or a tracked share and logs it on the timeline (assisted_whatsapp). The number is in the link only when the caller may see it; a masked number is revealed (audited, daily quota) only with `reveal`. Nothing is sent — the agent taps send in WhatsApp. A blocked contact, or a promotion to a contact who opted out or is suppressed, is refused (422); a service draft to them needs `override_reason`.

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

Request body

lead_id: Id or null
Opaque record id.
contact_id: Id or null
Opaque record id.
share_id: Id or null
Opaque record id.
textrequired: string
reveal: boolean
purpose: "promotional" | "service"
What the message is (default promotional): consent and suppression are checked for it.
override_reason: string or null
Why a service draft goes to a contact who opted out or is suppressed (recorded).

Response · 200

datarequired: object
data.urlrequired: string
data.textrequired: string
data.number_includedrequired: boolean
data.activity_idrequired: Id
Opaque record id.
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/whatsapp/assisted' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"lead_id":"cmusrceel0000q7kaafxqi1om","contact_id":"cmusrceel0000q7kaafxqi1om","share_id":"cmusrceel0000q7kaafxqi1om","text":"string","reveal":true,"purpose":"promotional","override_reason":"string"}'

Response example

{
  "data": {
    "url": "string",
    "text": "string",
    "number_included": true,
    "activity_id": "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.

POST/v1/whatsapp/connect

Connect WhatsApp with your own credentials

Checks the credentials with Meta, subscribes your app to the WABA and stores the token and secrets encrypted. The callback URL and verify token are shown once: paste them into your app’s WhatsApp webhook settings.

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

Request body

waba_idrequired: string
phone_number_idrequired: string
access_tokenrequired: string
app_secretrequired: string
app_id: string or null
verify_token: string or null
Generated when absent; shown once.

Response · 201

datarequired: object
data.connectionrequired: WhatsappConnection
data.conflictrequired: boolean
data.revealedrequired: object
data.revealed.verify_tokenrequired: string
data.revealed.callback_urlrequired: string
data.revealed.fieldsrequired: array of string
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/whatsapp/connect' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"waba_id":"string","phone_number_id":"string","access_token":"string","app_secret":"string","app_id":"string","verify_token":"string"}'

Response example

{
  "data": {
    "connection": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "status": "string",
      "health": "ok",
      "mode": "byo",
      "waba_id": "string",
      "waba_name": "string",
      "currency": "string",
      "review_status": "string",
      "subscribed": true,
      "app_id": "string",
      "token_hint": "string",
      "last_error": "string",
      "last_ok_at": "2026-10-06T05:30:00.000Z",
      "connected_at": "2026-10-06T05:30:00.000Z",
      "last_sync": {
        "at": "string",
        "error": "string",
        "templates": 0
      },
      "token": {
        "expires_at": "string",
        "reconnect": true
      },
      "account_health": {
        "checked_at": "string",
        "currency": "string",
        "payment_method": "present",
        "account_status": "string",
        "business_verification": "string",
        "can_send": "AVAILABLE",
        "problems": [
          {
            "entity": "string",
            "code": "string",
            "text": "string"
          }
        ],
        "error": "string"
      },
      "numbers": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "connection_id": "cmusrceel0000q7kaafxqi1om",
          "phone_number_id": "string",
          "address": "string",
          "display_phone_number": "string",
          "label": "string",
          "verified_name": "string",
          "name_status": "string",
          "quality_rating": "string",
          "messaging_limit_tier": "string",
          "throughput": "string",
          "status": "string",
          "meta_status": "string",
          "code_verification_status": "string",
          "coexistence": true,
          "is_default": true,
          "last_seen_at": "2026-10-06T05:30:00.000Z"
        }
      ]
    },
    "conflict": true,
    "revealed": {
      "verify_token": "string",
      "callback_url": "string",
      "fields": [
        "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.
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/whatsapp/connections/{id}

Disconnect WhatsApp

Wipes the token and secrets, stops routing webhooks here; numbers and conversations stay for history.

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.idrequired: Id
Opaque record id.
data.statusrequired: string
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "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/whatsapp/connections/{id}/refresh

Refresh numbers from Meta

Quality rating, messaging tier, display-name review and numbers added in WhatsApp Manager.

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: WhatsappConnection
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "status": "string",
    "health": "ok",
    "mode": "byo",
    "waba_id": "string",
    "waba_name": "string",
    "currency": "string",
    "review_status": "string",
    "subscribed": true,
    "app_id": "string",
    "token_hint": "string",
    "last_error": "string",
    "last_ok_at": "2026-10-06T05:30:00.000Z",
    "connected_at": "2026-10-06T05:30:00.000Z",
    "last_sync": {
      "at": "string",
      "error": "string",
      "templates": 0
    },
    "token": {
      "expires_at": "string",
      "reconnect": true
    },
    "account_health": {
      "checked_at": "string",
      "currency": "string",
      "payment_method": "present",
      "account_status": "string",
      "business_verification": "string",
      "can_send": "AVAILABLE",
      "problems": [
        {
          "entity": "string",
          "code": "string",
          "text": "string"
        }
      ],
      "error": "string"
    },
    "numbers": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "connection_id": "cmusrceel0000q7kaafxqi1om",
        "phone_number_id": "string",
        "address": "string",
        "display_phone_number": "string",
        "label": "string",
        "verified_name": "string",
        "name_status": "string",
        "quality_rating": "string",
        "messaging_limit_tier": "string",
        "throughput": "string",
        "status": "string",
        "meta_status": "string",
        "code_verification_status": "string",
        "coexistence": true,
        "is_default": true,
        "last_seen_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/whatsapp/connections/{id}/register

Register a WhatsApp number

Registers the number for the Cloud API with its six-digit two-step verification PIN.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

phone_number_idrequired: string
pinrequired: string

Response · 200

datarequired: WhatsappConnection
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/whatsapp/connections/{id}/register' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"phone_number_id":"string","pin":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "status": "string",
    "health": "ok",
    "mode": "byo",
    "waba_id": "string",
    "waba_name": "string",
    "currency": "string",
    "review_status": "string",
    "subscribed": true,
    "app_id": "string",
    "token_hint": "string",
    "last_error": "string",
    "last_ok_at": "2026-10-06T05:30:00.000Z",
    "connected_at": "2026-10-06T05:30:00.000Z",
    "last_sync": {
      "at": "string",
      "error": "string",
      "templates": 0
    },
    "token": {
      "expires_at": "string",
      "reconnect": true
    },
    "account_health": {
      "checked_at": "string",
      "currency": "string",
      "payment_method": "present",
      "account_status": "string",
      "business_verification": "string",
      "can_send": "AVAILABLE",
      "problems": [
        {
          "entity": "string",
          "code": "string",
          "text": "string"
        }
      ],
      "error": "string"
    },
    "numbers": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "connection_id": "cmusrceel0000q7kaafxqi1om",
        "phone_number_id": "string",
        "address": "string",
        "display_phone_number": "string",
        "label": "string",
        "verified_name": "string",
        "name_status": "string",
        "quality_rating": "string",
        "messaging_limit_tier": "string",
        "throughput": "string",
        "status": "string",
        "meta_status": "string",
        "code_verification_status": "string",
        "coexistence": true,
        "is_default": true,
        "last_seen_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/whatsapp/embedded-signup

Finish WhatsApp Embedded Signup

Exchanges the code from FB.login (within its ~30 s lifetime), subscribes PropZolo’s app to the WABA and, with a PIN, registers the number. 404 when PropZolo’s Meta app has no Embedded Signup configuration.

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

Request body

coderequired: string
waba_idrequired: string
phone_number_idrequired: string
business_id: string or null
pin: string or null

Response · 201

datarequired: object
data.connectionrequired: WhatsappConnection
data.conflictrequired: boolean
data.registeredrequired: boolean
data.register_errorrequired: string or null
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/whatsapp/embedded-signup' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"code":"string","waba_id":"string","phone_number_id":"string","business_id":"string","pin":"string"}'

Response example

{
  "data": {
    "connection": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "status": "string",
      "health": "ok",
      "mode": "byo",
      "waba_id": "string",
      "waba_name": "string",
      "currency": "string",
      "review_status": "string",
      "subscribed": true,
      "app_id": "string",
      "token_hint": "string",
      "last_error": "string",
      "last_ok_at": "2026-10-06T05:30:00.000Z",
      "connected_at": "2026-10-06T05:30:00.000Z",
      "last_sync": {
        "at": "string",
        "error": "string",
        "templates": 0
      },
      "token": {
        "expires_at": "string",
        "reconnect": true
      },
      "account_health": {
        "checked_at": "string",
        "currency": "string",
        "payment_method": "present",
        "account_status": "string",
        "business_verification": "string",
        "can_send": "AVAILABLE",
        "problems": [
          {
            "entity": "string",
            "code": "string",
            "text": "string"
          }
        ],
        "error": "string"
      },
      "numbers": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "connection_id": "cmusrceel0000q7kaafxqi1om",
          "phone_number_id": "string",
          "address": "string",
          "display_phone_number": "string",
          "label": "string",
          "verified_name": "string",
          "name_status": "string",
          "quality_rating": "string",
          "messaging_limit_tier": "string",
          "throughput": "string",
          "status": "string",
          "meta_status": "string",
          "code_verification_status": "string",
          "coexistence": true,
          "is_default": true,
          "last_seen_at": "2026-10-06T05:30:00.000Z"
        }
      ]
    },
    "conflict": true,
    "registered": true,
    "register_error": "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.
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/whatsapp/settings

WhatsApp messaging settings

“Send read receipts” (default on): customers see blue ticks when a member opens their thread and “typing…” while a member answers (official WhatsApp only; audited).

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

Request body

read_receiptsrequired: boolean

Response · 200

datarequired: object
data.read_receiptsrequired: boolean
metarequired: object

Request

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

Response example

{
  "data": {
    "read_receipts": 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/whatsapp/setup

WhatsApp connections and numbers

Connections with their numbers (quality, tier, name review), Embedded Signup availability, webhook.

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

Response · 200

datarequired: WhatsappSetup
metarequired: object

Request

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

Response example

{
  "data": {
    "connections": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "status": "string",
        "health": "ok",
        "mode": "byo",
        "waba_id": "string",
        "waba_name": "string",
        "currency": "string",
        "review_status": "string",
        "subscribed": true,
        "app_id": "string",
        "token_hint": "string",
        "last_error": "string",
        "last_ok_at": "2026-10-06T05:30:00.000Z",
        "connected_at": "2026-10-06T05:30:00.000Z",
        "last_sync": {
          "at": "string",
          "error": "string",
          "templates": 0
        },
        "token": {
          "expires_at": "string",
          "reconnect": true
        },
        "account_health": {
          "checked_at": "string",
          "currency": "string",
          "payment_method": "present",
          "account_status": "string",
          "business_verification": "string",
          "can_send": "AVAILABLE",
          "problems": [
            {
              "entity": null,
              "code": null,
              "text": null
            }
          ],
          "error": "string"
        },
        "numbers": [
          {
            "id": "cmusrceel0000q7kaafxqi1om",
            "connection_id": "cmusrceel0000q7kaafxqi1om",
            "phone_number_id": "string",
            "address": "string",
            "display_phone_number": "string",
            "label": "string",
            "verified_name": "string",
            "name_status": "string",
            "quality_rating": "string",
            "messaging_limit_tier": "string",
            "throughput": "string",
            "status": "string",
            "meta_status": "string",
            "code_verification_status": "string",
            "coexistence": true,
            "is_default": true,
            "last_seen_at": "2026-10-06T05:30:00.000Z"
          }
        ]
      }
    ],
    "embedded_signup": {
      "available": true,
      "app_id": "string",
      "config_id": "string",
      "graph_version": "string"
    },
    "webhook": {
      "callback_url": "string",
      "fields": [
        "string"
      ]
    },
    "read_receipts": 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/whatsapp/templates/sync

Sync templates from Meta

Statuses, quality and categories of every template of the connected WABAs (also ones made in Meta).

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

Response · 200

datarequired: object
data.connectionsrequired: integer
data.createdrequired: integer
data.updatedrequired: integer
data.unchangedrequired: integer
data.disabledrequired: integer
data.paused_broadcastsrequired: integer
data.errorsrequired: array of string
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/whatsapp/templates/sync' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "connections": 0,
    "created": 0,
    "updated": 0,
    "unchanged": 0,
    "disabled": 0,
    "paused_broadcasts": 0,
    "errors": [
      "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/whatsapp/templates/uploads

Upload a template header file

A presigned PUT for the header’s sample photo, video or PDF (JPEG / PNG ≤ 5 MB, MP4 ≤ 16 MB, PDF).

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

Request body

filenamerequired: string
content_typerequired: "image/jpeg" | "image/png" | "video/mp4" | "application/pdf"
sizerequired: integer

Response · 200

datarequired: InboxUpload
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/whatsapp/templates/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.

POST/v1/whatsapp/templates/{id}/submit

Submit a template to Meta

Sends a draft (or rejected / paused) WhatsApp template for review, with example values from its variables and the header sample file. Meta’s objections answer 422 with its message.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: MessageTemplate
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "channel": "sms",
    "name": "string",
    "display_name": "string",
    "language": "string",
    "category": "string",
    "use_case": "string",
    "header": null,
    "body": "string",
    "footer": "string",
    "buttons": null,
    "variables": [
      {
        "index": 1,
        "key": "string",
        "path": "string",
        "label": "string",
        "sample": "string",
        "fallback": "string",
        "max_length": 1
      }
    ],
    "provider_template_id": "string",
    "dlt_template_id": "string",
    "dlt_header": "string",
    "channel_account_id": "cmusrceel0000q7kaafxqi1om",
    "status": "draft",
    "rejection_reason": "string",
    "quality": "string",
    "last_synced_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "placeholders": 0,
    "sms": {
      "encoding": "gsm",
      "parts": 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/whatsapp/test

Test WhatsApp credentials

Reads the number and the WABA with the token (nothing is stored). Wrong values answer 422 per field.

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

Request body

waba_idrequired: string
phone_number_idrequired: string
access_tokenrequired: string
app_secretrequired: string
app_id: string or null

Response · 200

datarequired: WhatsappCredentialCheck
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/whatsapp/test' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"waba_id":"string","phone_number_id":"string","access_token":"string","app_secret":"string","app_id":"string"}'

Response example

{
  "data": {
    "number": {
      "phone_number_id": "string",
      "display_phone_number": "string",
      "verified_name": "string",
      "name_status": "string",
      "quality_rating": "string",
      "messaging_limit_tier": "string",
      "status": "string"
    },
    "waba": {
      "id": "string",
      "name": "string",
      "currency": "string",
      "review_status": "string"
    },
    "numbers": 0,
    "app_id": "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.
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.

curl -X POST 'https://api.propzolo.com/v1/whatsapp/assisted' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"lead_id":"cmusrceel0000q7kaafxqi1om","contact_id":"cmusrceel0000q7kaafxqi1om","share_id":"cmusrceel0000q7kaafxqi1om","text":"string","reveal":true,"purpose":"promotional","override_reason":"string"}'

curl -X POST 'https://api.propzolo.com/v1/whatsapp/connect' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"waba_id":"string","phone_number_id":"string","access_token":"string","app_secret":"string","app_id":"string","verify_token":"string"}'

{ "data": { "connection": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "status": "string", "health": "ok", "mode": "byo", "waba_id": "string", "waba_name": "string", "currency": "string", "review_status": "string", "subscribed": true, "app_id": "string", "token_hint": "string", "last_error": "string", "last_ok_at": "2026-10-06T05:30:00.000Z", "connected_at": "2026-10-06T05:30:00.000Z", "last_sync": { "at": "string", "error": "string", "templates": 0 }, "token": { "expires_at": "string", "reconnect": true }, "account_health": { "checked_at": "string", "currency": "string", "payment_method": "present", "account_status": "string", "business_verification": "string", "can_send": "AVAILABLE", "problems": [ { "entity": "string", "code": "string", "text": "string" } ], "error": "string" }, "numbers": [ { "id": "cmusrceel0000q7kaafxqi1om", "connection_id": "cmusrceel0000q7kaafxqi1om", "phone_number_id": "string", "address": "string", "display_phone_number": "string", "label": "string", "verified_name": "string", "name_status": "string", "quality_rating": "string", "messaging_limit_tier": "string", "throughput": "string", "status": "string", "meta_status": "string", "code_verification_status": "string", "coexistence": true, "is_default": true, "last_seen_at": "2026-10-06T05:30:00.000Z" } ] }, "conflict": true, "revealed": { "verify_token": "string", "callback_url": "string", "fields": [ "string" ] } }, "meta": {} }

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "status": "string", "health": "ok", "mode": "byo", "waba_id": "string", "waba_name": "string", "currency": "string", "review_status": "string", "subscribed": true, "app_id": "string", "token_hint": "string", "last_error": "string", "last_ok_at": "2026-10-06T05:30:00.000Z", "connected_at": "2026-10-06T05:30:00.000Z", "last_sync": { "at": "string", "error": "string", "templates": 0 }, "token": { "expires_at": "string", "reconnect": true }, "account_health": { "checked_at": "string", "currency": "string", "payment_method": "present", "account_status": "string", "business_verification": "string", "can_send": "AVAILABLE", "problems": [ { "entity": "string", "code": "string", "text": "string" } ], "error": "string" }, "numbers": [ { "id": "cmusrceel0000q7kaafxqi1om", "connection_id": "cmusrceel0000q7kaafxqi1om", "phone_number_id": "string", "address": "string", "display_phone_number": "string", "label": "string", "verified_name": "string", "name_status": "string", "quality_rating": "string", "messaging_limit_tier": "string", "throughput": "string", "status": "string", "meta_status": "string", "code_verification_status": "string", "coexistence": true, "is_default": true, "last_seen_at": "2026-10-06T05:30:00.000Z" } ] }, "meta": {} }

curl -X POST 'https://api.propzolo.com/v1/whatsapp/connections/{id}/register' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"phone_number_id":"string","pin":"string"}'

curl -X POST 'https://api.propzolo.com/v1/whatsapp/embedded-signup' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"code":"string","waba_id":"string","phone_number_id":"string","business_id":"string","pin":"string"}'

{ "data": { "connection": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "status": "string", "health": "ok", "mode": "byo", "waba_id": "string", "waba_name": "string", "currency": "string", "review_status": "string", "subscribed": true, "app_id": "string", "token_hint": "string", "last_error": "string", "last_ok_at": "2026-10-06T05:30:00.000Z", "connected_at": "2026-10-06T05:30:00.000Z", "last_sync": { "at": "string", "error": "string", "templates": 0 }, "token": { "expires_at": "string", "reconnect": true }, "account_health": { "checked_at": "string", "currency": "string", "payment_method": "present", "account_status": "string", "business_verification": "string", "can_send": "AVAILABLE", "problems": [ { "entity": "string", "code": "string", "text": "string" } ], "error": "string" }, "numbers": [ { "id": "cmusrceel0000q7kaafxqi1om", "connection_id": "cmusrceel0000q7kaafxqi1om", "phone_number_id": "string", "address": "string", "display_phone_number": "string", "label": "string", "verified_name": "string", "name_status": "string", "quality_rating": "string", "messaging_limit_tier": "string", "throughput": "string", "status": "string", "meta_status": "string", "code_verification_status": "string", "coexistence": true, "is_default": true, "last_seen_at": "2026-10-06T05:30:00.000Z" } ] }, "conflict": true, "registered": true, "register_error": "string" }, "meta": {} }

{ "data": { "connections": [ { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "status": "string", "health": "ok", "mode": "byo", "waba_id": "string", "waba_name": "string", "currency": "string", "review_status": "string", "subscribed": true, "app_id": "string", "token_hint": "string", "last_error": "string", "last_ok_at": "2026-10-06T05:30:00.000Z", "connected_at": "2026-10-06T05:30:00.000Z", "last_sync": { "at": "string", "error": "string", "templates": 0 }, "token": { "expires_at": "string", "reconnect": true }, "account_health": { "checked_at": "string", "currency": "string", "payment_method": "present", "account_status": "string", "business_verification": "string", "can_send": "AVAILABLE", "problems": [ { "entity": null, "code": null, "text": null } ], "error": "string" }, "numbers": [ { "id": "cmusrceel0000q7kaafxqi1om", "connection_id": "cmusrceel0000q7kaafxqi1om", "phone_number_id": "string", "address": "string", "display_phone_number": "string", "label": "string", "verified_name": "string", "name_status": "string", "quality_rating": "string", "messaging_limit_tier": "string", "throughput": "string", "status": "string", "meta_status": "string", "code_verification_status": "string", "coexistence": true, "is_default": true, "last_seen_at": "2026-10-06T05:30:00.000Z" } ] } ], "embedded_signup": { "available": true, "app_id": "string", "config_id": "string", "graph_version": "string" }, "webhook": { "callback_url": "string", "fields": [ "string" ] }, "read_receipts": true }, "meta": {} }

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

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "channel": "sms", "name": "string", "display_name": "string", "language": "string", "category": "string", "use_case": "string", "header": null, "body": "string", "footer": "string", "buttons": null, "variables": [ { "index": 1, "key": "string", "path": "string", "label": "string", "sample": "string", "fallback": "string", "max_length": 1 } ], "provider_template_id": "string", "dlt_template_id": "string", "dlt_header": "string", "channel_account_id": "cmusrceel0000q7kaafxqi1om", "status": "draft", "rejection_reason": "string", "quality": "string", "last_synced_at": "2026-10-06T05:30:00.000Z", "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z", "placeholders": 0, "sms": { "encoding": "gsm", "parts": 0 } }, "meta": {} }

curl -X POST 'https://api.propzolo.com/v1/whatsapp/test' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"waba_id":"string","phone_number_id":"string","access_token":"string","app_secret":"string","app_id":"string"}'

{ "data": { "number": { "phone_number_id": "string", "display_phone_number": "string", "verified_name": "string", "name_status": "string", "quality_rating": "string", "messaging_limit_tier": "string", "status": "string" }, "waba": { "id": "string", "name": "string", "currency": "string", "review_status": "string" }, "numbers": 0, "app_id": "string" }, "meta": {} }