zinn-campaigns

POST /v1/email-marketing/flows/{flow_id}/activate

Switch a flow on; only people who join the list from now on are enrolled.

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/flows/{flow_id}/activate \
  -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.manage. Refused (400) without at least one step, a postal address, or a body on every step. A paused flow resumes: its waiting steps are sent.

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

Response

NameTypeRequiredWhat it is
idstringYes—
namestringYes—
list_idstringYes—
sender_idstringYes—
from_namestringYes—
reply_tostringYes—
postal_addressstringYes—
triggerstring<list_join, date, cart_abandoned, product_viewed, post_purchase>Yes—
date_fieldstringYes—
statusstring<draft, active, paused>Yes—
activated_atstringYes—
last_refusal_codestringYesWhy the last due step was not sent (it is retried hourly); null while sending normally.
last_refusal_keystringYesThe refusal catalogue key behind last_refusal_code, to render in the reader's language.
created_atstringYes—
stepsEmailMarketingFlowStep[]No—
reportEmailMarketingFlowReportNo—

Errors this endpoint can return

400 · 401 · 403 · 404