Campaigns

POST `/v1/campaigns/preview`

Render a template with example values.

Autentizace

Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.

Sem patří ID vaší organizace

Tento koncový bod přijímá org_id jako pole v těle JSON.

ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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> }'

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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.

Tělo požadavku

Název	Typ	Požadováno	Co to je
`fallbacks`	`boolean`	Ne	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`	Ano	—
`subject`	`string`	Ano	—
`body`	`string`	Ano	—
`purpose`	`string<marketing, transactional>`	Ne	—
`channels`	`string<email, in_app, slack, telegram>[]`	Ne	—
`org_id`	`string`	Ne	—

Odpověď

Název	Typ	Požadováno	Co to je
`fallbacks`	`boolean`	Ne	Whether this was rendered with fallbacks only, echoed so the composer can label the panel honestly.
`subject`	`string`	Ano	—
`body_text`	`string`	Ano	—
`body_html`	`string`	Ano	—
`headers`	`object`	Ano	RFC 8058 one-click unsubscribe headers on a marketing message; empty otherwise.

Chyby, které může tento koncový bod vrátit

401 · 403 · 422