zinn-campaigns

GET /v1/email-marketing/cold

Whether Cold Outreach is open to the organisation.

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.view 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 GET https://api.zinndigital.com/v1/email-marketing/cold \
  -H "Authorization: Bearer zdk_live_…"

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.view. Cold Outreach is a separate mode from opted-in marketing (docs/1052 §11, ADR 0043): cold mail leaves only through mailboxes the customer connects, never through our sending pools. open is false until the mode is switched on for the organisation. cap_ceiling is the highest daily send cap a mailbox may be set to.

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…

Response

NameTypeRequiredWhat it is
attestationstringYesThe statement an import confirms (attested).
max_import_rowsintegerYesThe most leads one import request takes.
openbooleanYesWhether Cold Outreach may be used by the organisation.
cap_ceilingintegerYesThe highest daily cap a mailbox may be set to.
mailboxesintegerYesHow many mailboxes the organisation has connected.

Errors this endpoint can return

401 · 403 · 404