Campaigns

POST `/v1/campaigns/preview`

Render a template with example values.

Authenticatie

Stuur een API-sleutel mee als bearer token. Dit eindpunt vermeldt geen specifieke toestemming in de specificatie, dus geef uw sleutel de minimale rechten die nodig zijn en controleer het antwoord in plaats van zomaar wat aan te nemen.

Waar je organisatie-id komt te staan

Dit eindpunt verwacht org_id als een veld in de JSON-body.

Uw organisatie-id staat op het scherm met API-sleutels in uw dashboard, naast de sleutel zelf. Dit is in elke aanroep die u doet dezelfde id.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw 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> }'

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de 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.

Aanvraaglichaam

Naam	Type	Verplicht	Wat dit is
`fallbacks`	`boolean`	Nee	Preview 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 substitut…
`name`	`string`	Ja	—
`subject`	`string`	Ja	—
`body`	`string`	Ja	—
`purpose`	`string<marketing, transactional>`	Nee	—
`channels`	`string<email, in_app, slack, telegram>[]`	Nee	—
`org_id`	`string`	Nee	—

Reactie

Naam	Type	Verplicht	Wat dit is
`fallbacks`	`boolean`	Nee	Whether this was rendered with fallbacks only, echoed so the composer can label the panel honestly.
`subject`	`string`	Ja	—
`body_text`	`string`	Ja	—
`body_html`	`string`	Ja	—
`headers`	`object`	Ja	RFC 8058 one-click unsubscribe headers on a marketing message; empty otherwise.

Fouten die dit eindpunt kan retourneren

401 · 403 · 422