zinn-campaigns

POST /v1/email-marketing/whatsapp/connection

Connect this organisation's own WhatsApp Business Account (Meta Embedded Signup).

All zinn-campaigns endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

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/whatsapp/connection \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "code": <string>, "waba_id": <string>, "phone_number_id": <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. WhatsApp messages go out from the customer's OWN WhatsApp Business Account, never Zinn®'s. The dashboard opens Meta's Embedded Signup window with whatsapp_signup.app_id and whatsapp_signup.config_id from GET /v1/email-marketing/sms, and sends what it returns: the one-time code, the waba_id and the phone_number_id. The engine exchanges the code for the business token, checks the phone is on that account, subscribes our app to it and registers the phone; nothing is stored unless every step passes. The token is kept in Vault and never returned. Zinn®'s own accounts are refused. Refusal: CAMPAIGNS_WHATSAPP_CONNECT_FAILED (400, or 503 when signup is not set up or Meta did not answer; details[].code is one of not_configured, ids_invalid, not_in_good_standing (the account is suspended or closed), house_account, code_invalid, waba_not_shared, phone_not_on_waba, subscribe_failed, register_failed, vendor_unavailable). Audited (email_marketing.whatsapp.connect).

Parameters

NameTypeRequiredWhat it is
org_id (query)UuidNoThe 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…

Request body

NameTypeRequiredWhat it is
codestringYes—
waba_idstringYes—
phone_number_idstringYes—

Response

NameTypeRequiredWhat it is
sender_request_countriesstring[]YesCountries that open once this organisation's own sender name is registered there (POST /v1/email-marketing/sms/sender-requests). Approvals can take a few days.
sender_requestsEmailMarketingSenderRequest[]YesThe latest request per country.
sender_idstringYesThe alphanumeric SMS sender ID ("" when not set).
sender_id_countriesstring[]YesCountries where sender_id is used. Others need a registered number.
whatsapp_connectedbooleanYesThe organisation's own WhatsApp Business Account is connected.
whatsapp_display_phonestringYes—
whatsapp_healthEmailMarketingWhatsappHealthYesWhether Meta lets the organisation's OWN WhatsApp Business Account send (docs/1052 §3.5j), as last read (checked_at). blocked: Meta refuses its messages and our sends are…
whatsapp_signupobjectYesWhat the browser needs to open Meta's Embedded Signup window (our app id and its signup configuration id); null when WhatsApp signup is not offered yet.

Errors this endpoint can return

400 · 401 · 403 · 503