Campaigns

POST `/v1/campaigns/preview`

Render a template with example values.

Pagpapatotoo

Magpadala ng API key bilang bearer token. Ang endpoint na ito ay hindi naglatag ng tiyak na pahintulot sa pagtutukoy, kaya ibigay sa iyong key ang pinakamababang kailangan nito at suriin ang tugon sa halip na umasa.

Kung saan mapupunta ang id ng iyong organisasyon

Ang endpoint na ito ay kumukuha ng org_id bilang isang field sa JSON body.

Ang id ng iyong organisasyon ay nasa screen ng mga API key sa iyong dashboard, sa tabi mismo ng key. Ito ang parehong id sa bawat tawag na gagawin mo.

Subukan ito

Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.

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

Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API

Mga Detalye

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.

Katawan ng kahilingan

Pangalan	Uri	Kailangan	Ano ito
`fallbacks`	`boolean`	Hindi	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`	Oo	—
`subject`	`string`	Oo	—
`body`	`string`	Oo	—
`purpose`	`string<marketing, transactional>`	Hindi	—
`channels`	`string<email, in_app, slack, telegram>[]`	Hindi	—
`org_id`	`string`	Hindi	—

Tugon

Pangalan	Uri	Kailangan	Ano ito
`fallbacks`	`boolean`	Hindi	Whether this was rendered with fallbacks only, echoed so the composer can label the panel honestly.
`subject`	`string`	Oo	—
`body_text`	`string`	Oo	—
`body_html`	`string`	Oo	—
`headers`	`object`	Oo	RFC 8058 one-click unsubscribe headers on a marketing message; empty otherwise.

Mga error na maibabalik ng endpoint na ito

401 · 403 · 422