zinn-campaigns

PUT /v1/email-marketing/cold/countries/{country}

Override the Cold Outreach rule for one country, after the warning.

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 PUT https://api.zinndigital.com/v1/email-marketing/cold/countries/{country} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "rule": <string<refused, b2b_only, allowed>> }'

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. Any rule other than the default needs acknowledged: true: the screen shows a warning that the default reflects the country's law and the organisation is responsible for sending there. The override is audited as email_marketing.cold.country_override (country, rule, default, who, when). Setting the default rule again removes the override. 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…
country (path)stringYesISO 3166-1 alpha-2 code (UK is read as GB), or ZZ for unknown.

Request body

NameTypeRequiredWhat it is
rulestring<refused, b2b_only, allowed>Yes—
acknowledgedbooleanNoRequired (true) for any rule other than the default.

Response

NameTypeRequiredWhat it is
countrystringYes—
default_rulestring<refused, b2b_only, allowed>Yes—
basisstringNo—
override_rulestring<refused, b2b_only, allowed>No—
rulestring<refused, b2b_only, allowed>Yes—
acknowledged_atstringNo—

Errors this endpoint can return

400 · 401 · 403 · 404