Campaigns

POST `/v1/campaigns/preview`

Render a template with example values.

Pengesahan

Hantar kunci API sebagai token pembawa. Titik akhir ini tidak menyatakan kebenaran tertentu dalam spesifikasi, jadi berikan kunci anda kebenaran minimum yang diperlukan dan semak respons tersebut daripada membuat andaian.

Tempat ID organisasi anda diletakkan

Titik akhir ini mengambil org_id sebagai medan dalam kandungan JSON.

ID organisasi anda terletak pada skrin kekunci API dalam papan pemuka anda, di sebelah kekunci itu sendiri. Ia adalah ID yang sama dalam setiap panggilan yang anda buat.

Cuba

Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka 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 log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API

Butiran

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.

Badan permintaan

Nama	Jenis	Diperlukan	Apakah ia
`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	—

Respons

Nama	Jenis	Diperlukan	Apakah ia
`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.

Ralat yang boleh dikembalikan oleh titik akhir ini

401 · 403 · 422