ZingaConnect API
These are the ZingaConnect messaging endpoints of the Zingasuite API — they let
your own applications send WhatsApp messages, check message delivery status,
read a conversation's status and assignee, and register webhooks for delivery,
inbound and assignment events — using ZingaConnect as your messaging provider. It is the same delivery pipeline ZingaConnect uses for its
own campaigns and inbox, so messages you send through the API appear alongside
them in the console.
The API also exposes your CRM data — contacts, lists, campaigns, email/SMS and
WhatsApp templates, teams and agents — as uniform CRUD endpoints under
/papi/v1/crm/, so you can sync your CRM with other systems.
Sends are asynchronous: a send returns 202 Accepted and is queued, and you
track its progress through the message status endpoint or a webhook rather than
holding the request open.
Access
Every request needs a zk_ API key sent as a bearer token. The messaging
endpoints use their own scopes, separate from the data scopes — a data:write:*
key does not grant messaging:
messaging:read— list channels, read message status and read conversations.messaging:send— send messages.messaging:webhooks— manage delivery and inbound webhooks.
The CRM resource endpoints (/papi/v1/crm/*) instead use the standard data
scopes: data:read to read and data:write:* to create, update or delete.
The base URL is:
https://api-v1.zingasuite.com/papi/v1
Sections
- Messaging API — list channels, send WhatsApp
messages, read message status, read conversations (status + assignee), and
manage webhooks. - CRM Resources — CRUD for contacts, lists, campaigns,
email/SMS templates, teams and agents (plus read-only WhatsApp templates).
Shared rules
The conventions that apply to every Zingasuite endpoint — how keys work, request
and response shapes, error codes and rate limits — live in the Developer API
chapter:
You can try these endpoints live, with your own key, in the interactive explorer
at /_solve/api.