Campaigns

POST `/v1/campaigns/preview`

Render a template with example values.

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.

A szervezet azonosítójának helye

Ez a végpont a org_id mezőt várja a JSON törzsben.

A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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.

Kérés törzse

Név	Típus	Kötelező	Mi ez
`fallbacks`	`boolean`	Nem	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`	Igen	—
`subject`	`string`	Igen	—
`body`	`string`	Igen	—
`purpose`	`string<marketing, transactional>`	Nem	—
`channels`	`string<email, in_app, slack, telegram>[]`	Nem	—
`org_id`	`string`	Nem	—

Válasz

Név	Típus	Kötelező	Mi ez
`fallbacks`	`boolean`	Nem	Whether this was rendered with fallbacks only, echoed so the composer can label the panel honestly.
`subject`	`string`	Igen	—
`body_text`	`string`	Igen	—
`body_html`	`string`	Igen	—
`headers`	`object`	Igen	RFC 8058 one-click unsubscribe headers on a marketing message; empty otherwise.

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 422