ZingaConnect API · ZingaConnect

Channels

The messaging channels (WhatsApp numbers, etc.) you can send from.

GET/messaging/channelsList messaging channels

Requires messaging:read. Use a channel id as channelConfigId when sending.

TrialServerAuth token → Authorization

Messages

Send WhatsApp messages and read their delivery status.

POST/messaging/whatsapp/sendSend a WhatsApp message

Requires messaging:send. Queued for delivery (202). type: text|template|media|interactive.

TrialServerAuth token → AuthorizationRequest body (JSON)

GET/messaging/messages/{id}Read message status

Requires messaging:read.

Name	In	Type	Req	Description
`id`	path	string	yes	Message id

TrialServerAuth token → Authorizationid (path, required)

Webhooks

Receive delivery + inbound events. Requires `messaging:webhooks`.

GET/messaging/webhooksList webhooks

TrialServerAuth token → Authorization

POST/messaging/webhooksRegister a webhook

Events are signed X-Zinga-Signature: sha256=… when a secret is set.

TrialServerAuth token → AuthorizationRequest body (JSON)

DELETE/messaging/webhooks/{id}Delete a webhook

Name	In	Type	Req	Description
`id`	path	string	yes	Webhook id

TrialServerAuth token → Authorizationid (path, required)

Contacts

The shared contact spine (identity + per-channel marketing consent).

GET/crm/contactsList contact

Name	In	Type	Description
`limit`	query	integer	Page size (1-200, default 50)
`offset`	query	integer	Rows to skip
`q`	query	string	Free-text search

TrialServerAuth token → Authorizationlimit (query)offset (query)q (query)

GET/crm/contacts/{id}Get a contact record

Name	In	Type	Req	Description
`id`	path	string	yes	Row id

TrialServerAuth token → Authorizationid (path, required)

POST/crm/contactsCreate a contact record

TrialServerAuth token → AuthorizationRequest body (JSON)

PATCH/crm/contacts/{id}Update a contact record

Name	In	Type	Req	Description
`id`	path	string	yes	Row id

TrialServerAuth token → Authorizationid (path, required)Request body (JSON)

DELETE/crm/contacts/{id}Delete a contact record

Name	In	Type	Req	Description
`id`	path	string	yes	Row id

TrialServerAuth token → Authorizationid (path, required)

Lists

Static or dynamic (filter-based) contact lists used as campaign audiences.

GET/crm/listsList list

Name	In	Type	Description
`limit`	query	integer	Page size (1-200, default 50)
`offset`	query	integer	Rows to skip
`q`	query	string	Free-text search

TrialServerAuth token → Authorizationlimit (query)offset (query)q (query)

GET/crm/lists/{id}Get a list record

Name	In	Type	Req	Description
`id`	path	string	yes	Row id

TrialServerAuth token → Authorizationid (path, required)

POST/crm/listsCreate a list record

TrialServerAuth token → AuthorizationRequest body (JSON)

PATCH/crm/lists/{id}Update a list record

Name	In	Type	Req	Description
`id`	path	string	yes	Row id

TrialServerAuth token → Authorizationid (path, required)Request body (JSON)

DELETE/crm/lists/{id}Delete a list record

Name	In	Type	Req	Description
`id`	path	string	yes	Row id

TrialServerAuth token → Authorizationid (path, required)

Campaigns

Campaign definitions (drip / calendar / broadcast). Build the shell here, wire steps, then activate (see Campaign steps & lifecycle). `status` is not writable here — use the activate/pause actions.

GET/crm/campaignsList campaign

Name	In	Type	Description
`limit`	query	integer	Page size (1-200, default 50)
`offset`	query	integer	Rows to skip
`q`	query	string	Free-text search

TrialServerAuth token → Authorizationlimit (query)offset (query)q (query)

GET/crm/campaigns/{id}Get a campaign record

Name	In	Type	Req	Description
`id`	path	string	yes	Row id

TrialServerAuth token → Authorizationid (path, required)

POST/crm/campaignsCreate a campaign record

TrialServerAuth token → AuthorizationRequest body (JSON)

PATCH/crm/campaigns/{id}Update a campaign record

Name	In	Type	Req	Description
`id`	path	string	yes	Row id

TrialServerAuth token → Authorizationid (path, required)Request body (JSON)

DELETE/crm/campaigns/{id}Delete a campaign record

Name	In	Type	Req	Description
`id`	path	string	yes	Row id

TrialServerAuth token → Authorizationid (path, required)

Campaign steps & lifecycle

Wire the drip sequence (which template fires at which delay) and activate/pause the campaign. Steps are children of a campaign.

GET/crm/campaigns/{campaign_id}/stepsList a campaign's steps

Name	In	Type	Req	Description
`campaign_id`	path	string	yes	Campaign id

TrialServerAuth token → Authorizationcampaign_id (path, required)

POST/crm/campaigns/{campaign_id}/stepsAdd a step (template at a delay)

channel = email|sms|whatsapp; give messageTemplateId (email/sms) or waTemplateId (whatsapp) + delayAmount / delayUnit.

Name	In	Type	Req	Description
`campaign_id`	path	string	yes	Campaign id

TrialServerAuth token → Authorizationcampaign_id (path, required)Request body (JSON)

PATCH/crm/campaigns/{campaign_id}/steps/{step_id}Update a step

Name	In	Type	Req	Description
`campaign_id`	path	string	yes	Campaign id
`step_id`	path	string	yes	Step id

TrialServerAuth token → Authorizationcampaign_id (path, required)step_id (path, required)Request body (JSON)

DELETE/crm/campaigns/{campaign_id}/steps/{step_id}Delete a step

Name	In	Type	Req	Description
`campaign_id`	path	string	yes	Campaign id
`step_id`	path	string	yes	Step id

TrialServerAuth token → Authorizationcampaign_id (path, required)step_id (path, required)

POST/crm/campaigns/{campaign_id}/activateActivate (enrol the audience)

Name	In	Type	Req	Description
`campaign_id`	path	string	yes	Campaign id

TrialServerAuth token → Authorizationcampaign_id (path, required)

POST/crm/campaigns/{campaign_id}/pausePause or resume

Name	In	Type	Req	Description
`campaign_id`	path	string	yes	Campaign id

TrialServerAuth token → Authorizationcampaign_id (path, required)

Email & SMS templates

Reusable email/SMS content with {{merge_field}} tokens (resource key `message-templates`).

GET/crm/message-templatesList template

Name	In	Type	Description
`limit`	query	integer	Page size (1-200, default 50)
`offset`	query	integer	Rows to skip
`q`	query	string	Free-text search

TrialServerAuth token → Authorizationlimit (query)offset (query)q (query)

GET/crm/message-templates/{id}Get a template record

Name	In	Type	Req	Description
`id`	path	string	yes	Row id

TrialServerAuth token → Authorizationid (path, required)

POST/crm/message-templatesCreate a template record

TrialServerAuth token → AuthorizationRequest body (JSON)

PATCH/crm/message-templates/{id}Update a template record

Name	In	Type	Req	Description
`id`	path	string	yes	Row id

TrialServerAuth token → Authorizationid (path, required)Request body (JSON)

DELETE/crm/message-templates/{id}Delete a template record

Name	In	Type	Req	Description
`id`	path	string	yes	Row id

TrialServerAuth token → Authorizationid (path, required)

Email headers

Reusable HTML header blocks (masthead / logo / banner) an email template prepends via `headerId`.

GET/crm/email-headersList email header

Name	In	Type	Description
`limit`	query	integer	Page size (1-200, default 50)
`offset`	query	integer	Rows to skip
`q`	query	string	Free-text search

TrialServerAuth token → Authorizationlimit (query)offset (query)q (query)

GET/crm/email-headers/{id}Get a email header record

Name	In	Type	Req	Description
`id`	path	string	yes	Row id

TrialServerAuth token → Authorizationid (path, required)

POST/crm/email-headersCreate a email header record

TrialServerAuth token → AuthorizationRequest body (JSON)

PATCH/crm/email-headers/{id}Update a email header record

Name	In	Type	Req	Description
`id`	path	string	yes	Row id

TrialServerAuth token → Authorizationid (path, required)Request body (JSON)

DELETE/crm/email-headers/{id}Delete a email header record

Name	In	Type	Req	Description
`id`	path	string	yes	Row id

TrialServerAuth token → Authorizationid (path, required)

WhatsApp templates

List templates + their Meta approval status, create a template (submits to Meta for review), edit it while it's still a LOCAL draft, and submit a draft. Once submitted to Meta a template is immutable.

GET/crm/whatsapp-templatesList WhatsApp template

Name	In	Type	Description
`limit`	query	integer	Page size (1-200, default 50)
`offset`	query	integer	Rows to skip
`q`	query	string	Free-text search

TrialServerAuth token → Authorizationlimit (query)offset (query)q (query)

GET/crm/whatsapp-templates/{id}Get a WhatsApp template record

Name	In	Type	Req	Description
`id`	path	string	yes	Row id

TrialServerAuth token → Authorizationid (path, required)

POST/crm/whatsapp-templatesCreate a WhatsApp template (submit to Meta)

Creates the template and, by default (submitNow: true), submits it to Meta for review. category = MARKETING | UTILITY | AUTHENTICATION; the name is normalized (lowercased, spaces to underscores). Provide sample values for the {{n}} variables in example.body (and example.header) — Meta requires a sample per variable; any you omit default to 'Sample'. The mapping is stored on the template.

TrialServerAuth token → AuthorizationRequest body (JSON)

PATCH/crm/whatsapp-templates/{id}Edit a LOCAL draft

Edit a template while it's still a LOCAL draft (not yet submitted). Returns 400 not_editable once it's been submitted to Meta. Pass submitNow: true to submit after editing.

Name	In	Type	Req	Description
`id`	path	string	yes	Template id

TrialServerAuth token → Authorizationid (path, required)Request body (JSON)

POST/crm/whatsapp-templates/{id}/submitSubmit a LOCAL draft to Meta

Name	In	Type	Req	Description
`id`	path	string	yes	Template id

TrialServerAuth token → Authorizationid (path, required)

Teams

Sales/agent teams.

GET/crm/teamsList team

Name	In	Type	Description
`limit`	query	integer	Page size (1-200, default 50)
`offset`	query	integer	Rows to skip
`q`	query	string	Free-text search

TrialServerAuth token → Authorizationlimit (query)offset (query)q (query)

GET/crm/teams/{id}Get a team record

Name	In	Type	Req	Description
`id`	path	string	yes	Row id

TrialServerAuth token → Authorizationid (path, required)

POST/crm/teamsCreate a team record

TrialServerAuth token → AuthorizationRequest body (JSON)

PATCH/crm/teams/{id}Update a team record

Name	In	Type	Req	Description
`id`	path	string	yes	Row id

TrialServerAuth token → Authorizationid (path, required)Request body (JSON)

DELETE/crm/teams/{id}Delete a team record

Name	In	Type	Req	Description
`id`	path	string	yes	Row id

TrialServerAuth token → Authorizationid (path, required)

Agents

Team members with CRM access (links a platform user to an access tier).

GET/crm/agentsList agent

Name	In	Type	Description
`limit`	query	integer	Page size (1-200, default 50)
`offset`	query	integer	Rows to skip
`q`	query	string	Free-text search

TrialServerAuth token → Authorizationlimit (query)offset (query)q (query)

GET/crm/agents/{id}Get a agent record

Name	In	Type	Req	Description
`id`	path	string	yes	Row id

TrialServerAuth token → Authorizationid (path, required)

POST/crm/agentsCreate a agent record

TrialServerAuth token → AuthorizationRequest body (JSON)

PATCH/crm/agents/{id}Update a agent record

Name	In	Type	Req	Description
`id`	path	string	yes	Row id

TrialServerAuth token → Authorizationid (path, required)Request body (JSON)

DELETE/crm/agents/{id}Delete a agent record

Name	In	Type	Req	Description
`id`	path	string	yes	Row id

TrialServerAuth token → Authorizationid (path, required)

ZingaConnect API v1

Channels

Messages

Webhooks

Contacts

Lists

Campaigns

Campaign steps & lifecycle

Email & SMS templates

Email headers

WhatsApp templates

Teams

Agents