zinn-campaigns

POST `/v1/email-marketing/contacts/{contact_id}/messages`

Send one SMS to one contact, paid from the Zinn® credit balance.

Authentication

Send an API key as a bearer token. The key must carry the email_marketing.manage permission; a key without it is refused with 403, not 404.

Where your organisation id goes

This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X POST https://api.zinndigital.com/v1/email-marketing/contacts/{contact_id}/messages \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "text": <string> }'

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Gated on email_marketing.manage. Every guard runs before the provider is called: the line and SMS switches, the account's good standing, the contact's SMS consent, this organisation's spike pause, an open country, and the credit — the price (parts x the country's price per part) is debited BEFORE sending and returned if the network refuses the message. Refusals carry a refusal.campaigns.channel* key: CAMPAIGNS_NO_CREDIT (402), CAMPAIGNS_NO_CONSENT / CAMPAIGNS_SUPPRESSED / CAMPAIGNS_NO_PHONE / CAMPAIGNS_PAUSED (409), CAMPAIGNS_UNPRICED / CAMPAIGNS_COUNTRY_NOT_OPEN / CAMPAIGNS_VENDOR_REFUSED (422), CAMPAIGNS_TOO_LONG (400), CAMPAIGNS_NOT_OPEN / CAMPAIGNS_CHANNEL_OFF / CAMPAIGNS_ACCOUNT_ON_HOLD (403), and CAMPAIGNS_VENDOR_UNAVAILABLE / CAMPAIGNS_NOT_CONFIGURED (503). One message per call; audited (email_marketing.message.send).

Parameters

Name	Type	Required	What it is
`org_id (query)`	`Uuid`	No	The organization this call acts on. Optional for a caller with exactly one direct membership; required for anyone with more than one — which is every reseller and every agency…
`contact_id (path)`	`string`	Yes	—

Request body

Name	Type	Required	What it is
`channel`	`string<sms>`	No	—
`text`	`string`	Yes	The message. At most 1,530 characters (10 parts) are sent.

Response

Name	Type	Required	What it is
`id`	`string`	Yes	—
`channel`	`string<sms, whatsapp>`	Yes	—
`contact_id`	`string`	Yes	—
`country`	`string`	Yes	—
`parts`	`integer`	Yes	—
`price_usd_micros`	`integer`	Yes	—
`status`	`string<reserved, sent, refunded>`	Yes	—
`created_at`	`string`	Yes	—

Errors this endpoint can return

400 · 401 · 402 · 403 · 409 · 422 · 503