Campaigns

POST `/v1/campaigns/preview`

Render a template with example values.

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.

Де вказується ідентифікатор вашої організації

Цей ендпоінт приймає org_id як поле в тілі JSON.

Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

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

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

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.

Тіло запиту

Назва	Тип	Обов'язкове	Що це таке
`fallbacks`	`boolean`	Ні	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`	Так	—
`subject`	`string`	Так	—
`body`	`string`	Так	—
`purpose`	`string<marketing, transactional>`	Ні	—
`channels`	`string<email, in_app, slack, telegram>[]`	Ні	—
`org_id`	`string`	Ні	—

Відповідь

Назва	Тип	Обов'язкове	Що це таке
`fallbacks`	`boolean`	Ні	Whether this was rendered with fallbacks only, echoed so the composer can label the panel honestly.
`subject`	`string`	Так	—
`body_text`	`string`	Так	—
`body_html`	`string`	Так	—
`headers`	`object`	Так	RFC 8058 one-click unsubscribe headers on a marketing message; empty otherwise.

Помилки, які може повертати ця кінцева точка

401 · 403 · 422