Campaigns

POST `/v1/campaigns/preview`

Render a template with example values.

Նույնականացում

Ուղարկեք API բանալին որպես bearer թոքեն։ Այս վերջնակետը բնութագրում չի նշում որոշակի թույլտվության մասին, ուստի տվեք ձեր բանալուն նվազագույն անհրաժեշտը և ենթադրություններ անելու փոխարեն ստուգեք պատասխանը:

Որտեղ տեղադրվում է ձեր կազմակերպության ID-ն

Այս վերջնակետը JSON մարմնում որպես դաշտ վերցնում է org_id-ը։

Ձեր կազմակերպության ID-ն գտնվում է Ձեր ղեկավարման վահանակի API բանալիների էկրանին՝ բուն բանալու կողքին: Այն նույն ID-ն է Ձեր կատարած յուրաքանչյուր հարցման մեջ:

Փորձել

Փոխարինեք անկյունային փակագծերում գտնվող ցանկացած բան ձեր սեփական արժեքներով, և բանալու տեղապահը՝ ձեր վահանակի բանալիով:

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 վահանակը լրացնում է ձեր իրական կազմակերպության ID-ն և ձեր սեփական բանալին և գործարկում է հարցումը ուղիղ 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