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, за да можете да видите действителния отговор. Отворете този крайpoint в 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.

Грешки, които този крайpoint може да върне

401 · 403 · 422