zinn-campaigns

POST /v1/email-marketing/cold/mailboxes

Connect a mailbox (SMTP to send, IMAP to read replies) for Cold Outreach.

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/cold/mailboxes \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "email": <string>, "smtp_host": <string>, "imap_host": <string>, "password": <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 mailbox must be the customer's own: a domain we host, a domain whose mail we receive, one of our own domains, or a domain the organisation already sends opted-in campaigns from is refused (refusal.campaigns.cold*), so cold mail never shares reputation with marketing or hosted mail. The password goes to the secret store and is never returned. The mailbox is checked in the background at once (verifying). 403 while the mode is not open to the organisation; 409 when the address is already connected. 404 (refusal.campaigns.gone) when the caller has no acting organisation.

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
providerstring<imap_smtp, gmail, zoho, yahoo, icloud, fastmail>NoThe sender-providers mailbox row the servers came from (its DKIM selectors and SPF include decide the DNS records the mailbox is told to publish), or imap_smtp for any other…
emailstringYes—
display_namestringNo—
smtp_hoststringYes—
smtp_portinteger<25, 465, 587, 2525>No—
smtp_tlsstring<starttls, implicit>No—
imap_hoststringYes—
imap_portinteger<993>No—
usernamestringNoDefaults to email.
passwordstringYes—

Response

NameTypeRequiredWhat it is
idstringYes—
providerstringYes—
emailstringYes—
domainstringYes—
display_namestringNo—
smtp_hoststringNo—
smtp_portintegerNo—
smtp_tlsstringNo—
imap_hoststringNo—
imap_portintegerNo—
usernamestringNo—
statusstring<unverified, verifying, verified, failing>Yes—
status_codestringNoWhy the last check failed, as a refusal key (refusal.campaigns.cold* or a connection refusal) the dashboard translates, or empty.
verified_atstringNo—
daily_capintegerYes—
min_gap_secondsintegerYes—
pausedbooleanYes—
created_atstringYes—
dns_healthEmailMarketingSenderHealthNoThe newest SPF / DKIM / DMARC reading of the mailbox's domain, taken by every check (on connect and "Check"), with the exact record to publish for anything missing; expected…

Errors this endpoint can return

400 · 401 · 403 · 404 · 409 · 503