Campaigns

POST `/v1/campaigns/preview`

Render a template with example values.

Uwierzytelnianie

Wyślij klucz API jako token bearer. Ten punkt końcowy nie określa konkretnego uprawnienia w specyfikacji, więc nadaj swojemu kluczowi minimum potrzebnych uprawnień i sprawdź odpowiedź zamiast zakładać.

Miejsce na identyfikator organizacji

Ten punkt końcowy przyjmuje org_id jako pole w treści JSON.

Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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.

Treść żądania

Nazwa	Typ	Wymagane	Co to jest
`fallbacks`	`boolean`	Nie	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`	Tak	—
`subject`	`string`	Tak	—
`body`	`string`	Tak	—
`purpose`	`string<marketing, transactional>`	Nie	—
`channels`	`string<email, in_app, slack, telegram>[]`	Nie	—
`org_id`	`string`	Nie	—

Odpowiedź

Nazwa	Typ	Wymagane	Co to jest
`fallbacks`	`boolean`	Nie	Whether this was rendered with fallbacks only, echoed so the composer can label the panel honestly.
`subject`	`string`	Tak	—
`body_text`	`string`	Tak	—
`body_html`	`string`	Tak	—
`headers`	`object`	Tak	RFC 8058 one-click unsubscribe headers on a marketing message; empty otherwise.

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 422