zinn-campaigns

PATCH /v1/email-marketing/cold/mailboxes/{mailbox_id}

Change a mailbox's name, daily cap, gap between sends, or pause it.

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 PATCH https://api.zinndigital.com/v1/email-marketing/cold/mailboxes/{mailbox_id} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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. daily_cap is 1 to the cap ceiling; a cap above it is refused with 400.

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…
mailbox_id (path)stringYes—

Request body

NameTypeRequiredWhat it is
display_namestringNo—
daily_capintegerNo—
min_gap_secondsintegerNo—
pausedbooleanNo—

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