Campaigns

POST `/v1/campaigns/preview`

Render a template with example values.

Аутентификация

API кілтін bearer токені ретінде жіберіңіз. Бұл соңғы нүкте сипаттамада арнайы рұқсатты көрсетпейді, сондықтан болжағаннан гөрі кілтіңізге қажетті ең аз рұқсатты беріп, жауапты тексеріңіз.

Ұйымыңыздың идентификаторы орналасатын жер

Бұл соңғы нүкте JSON корпусында өріс ретінде org_id қабылдайды.

Сіздің ұйым идентификаторыңыз басқару панеліндегі 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.

Сұрау денесі

Аты	Tүрі	Міндетті	Мазмұны
`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`	Жоқ	—

Жауап

Аты	Tүрі	Міндетті	Мазмұны
`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