zinn-campaigns
PUT /v1/email-marketing/zerobounce
Connect (or replace) this organisation's own ZeroBounce API key.
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 PUT https://api.zinndigital.com/v1/email-marketing/zerobounce \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "api_key": <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. The key is checked first with ZeroBounce's free credit-balance call, then stored in Vault; nothing is stored when the check fails. A key ZeroBounce does not accept is refused with 400 (refusal.campaigns.zerobounceKeyInvalid); ZeroBounce not answering is 503 (refusal.campaigns.zerobounceUnavailable), and our secret store not answering is 503 (refusal.campaigns.vaultUnavailable). Campaigns that were paused waiting for a key (zerobounce_key) carry on by themselves. Audited as email_marketing.zerobounce.connect with the credit balance (never the key).
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… |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
api_key | string | Yes | The API key from the organisation's own ZeroBounce account. Write-only. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
connected | boolean | Yes | — |
key_hint | string | Yes | The key's last four characters; null when none is connected. |
connected_at | string | Yes | — |
modes | string<off, invalid, risky>[] | Yes | — |
credits | integer | No | Only on PUT: the credit balance ZeroBounce reported for the key. |
Errors this endpoint can return
400 · 401 · 403 · 404 · 503