campaigns

POST /v1/campaigns/preview

Render a template with example values.

All 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 endpoint checks campaigns.view; a key without it is refused with 403, not 404.

Where your organisation id goes

This endpoint takes org_id as a field in the JSON body.

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/campaigns/preview \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string>, "subject": <string>, "body": <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

Rendered by the engine, through the same renderer the send uses. A preview computed in the client is a second implementation of the substitution rules, and the first time it disagrees an author ships copy they never actually saw.

Request body

NameTypeRequiredWhat it is
fallbacksbooleanNoPreview only. Render with NO merge values, so every tag falls back and the author reads what a customer we know nothing about reads. It exists because a normal preview substitutes…
namestringYes—
subjectstringYes—
bodystringYes—
purposestring<marketing, transactional>No—
channelsstring<email, in_app, slack, telegram>[]No—
org_idstringNo—

Response

NameTypeRequiredWhat it is
fallbacksbooleanNoWhether this was rendered with fallbacks only, echoed so the composer can label the panel honestly.
subjectstringYes—
body_textstringYes—
body_htmlstringYes—
headersobjectYesRFC 8058 one-click unsubscribe headers on a marketing message; empty otherwise.

Errors this endpoint can return

401 · 403 · 422