Campaigns

POST `/v1/campaigns/preview`

Render a template with example values.

Autentikasi

Kirimkan kunci API sebagai token bearer. Titik akhir ini tidak menyatakan izin tertentu dalam spesifikasi, jadi berikan kunci Anda izin minimum yang diperlukan dan periksa responsnya alih-alih berasumsi.

Tempat ID organisasi Anda dimasukkan

Titik akhir ini memerlukan org_id sebagai field dalam bodi JSON.

ID organisasi Anda berada di layar kunci API di dasbor Anda, di sebelah kunci itu sendiri. Itu adalah ID yang sama dalam setiap panggilan yang Anda buat.

Coba

Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.

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

Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API

Detail

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.

Isi permintaan

Nama	Jenis	Wajib	Tentang apa ini
`fallbacks`	`boolean`	Tidak	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`	Ya	—
`subject`	`string`	Ya	—
`body`	`string`	Ya	—
`purpose`	`string<marketing, transactional>`	Tidak	—
`channels`	`string<email, in_app, slack, telegram>[]`	Tidak	—
`org_id`	`string`	Tidak	—

Tanggapan

Nama	Jenis	Wajib	Tentang apa ini
`fallbacks`	`boolean`	Tidak	Whether this was rendered with fallbacks only, echoed so the composer can label the panel honestly.
`subject`	`string`	Ya	—
`body_text`	`string`	Ya	—
`body_html`	`string`	Ya	—
`headers`	`object`	Ya	RFC 8058 one-click unsubscribe headers on a marketing message; empty otherwise.

Kesalahan yang dapat dikembalikan oleh titik akhir ini

401 · 403 · 422