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