Campaigns

POST `/v1/campaigns/preview`

Render a template with example values.

Autentifikacija

Pošaljite API ključ kao bearer token. Ova krajnja točka ne navodi određenu dozvolu u specifikaciji, stoga dajte svom ključu najmanje što mu je potrebno i provjerite odgovor umjesto da pretpostavljate.

Gdje dolazi ID vaše organizacije

Ova krajnja točka prihvaća org_id kao polje u JSON tijelu.

ID vaše organizacije nalazi se na zaslonu API ključeva u vašoj nadzornoj ploči, pored samog ključa. To je isti ID u svakom pozivu koji uputite.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

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

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

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.

Tijelo zahtjeva

Naziv	Vrsta	Obavezno	Što je to
`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`	Da	—
`subject`	`string`	Da	—
`body`	`string`	Da	—
`purpose`	`string<marketing, transactional>`	Ne	—
`channels`	`string<email, in_app, slack, telegram>[]`	Ne	—
`org_id`	`string`	Ne	—

Odgovor

Naziv	Vrsta	Obavezno	Što je to
`fallbacks`	`boolean`	Ne	Whether this was rendered with fallbacks only, echoed so the composer can label the panel honestly.
`subject`	`string`	Da	—
`body_text`	`string`	Da	—
`body_html`	`string`	Da	—
`headers`	`object`	Da	RFC 8058 one-click unsubscribe headers on a marketing message; empty otherwise.

Pogreške koje ova krajnja točka može vratiti

401 · 403 · 422