Campaigns

POST `/v1/campaigns/preview`

Render a template with example values.

Tous les points de terminaison Campaigns

Authentification

Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.

Où insérer l'ID de votre organisation

Cet endpoint prend org_id comme champ dans le corps JSON.

L'identifiant de votre organisation se trouve sur l'écran des clés API de votre tableau de bord, à côté de la clé elle-même. Il s'agit du même identifiant pour chaque appel que vous effectuez.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

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

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

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.

Corps de la requête

Nom	Type	Obligatoire	Qu'est-ce que c'est
`fallbacks`	`boolean`	Non	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`	Oui	—
`subject`	`string`	Oui	—
`body`	`string`	Oui	—
`purpose`	`string<marketing, transactional>`	Non	—
`channels`	`string<email, in_app, slack, telegram>[]`	Non	—
`org_id`	`string`	Non	—

Réponse

Nom	Type	Obligatoire	Qu'est-ce que c'est
`fallbacks`	`boolean`	Non	Whether this was rendered with fallbacks only, echoed so the composer can label the panel honestly.
`subject`	`string`	Oui	—
`body_text`	`string`	Oui	—
`body_html`	`string`	Oui	—
`headers`	`object`	Oui	RFC 8058 one-click unsubscribe headers on a marketing message; empty otherwise.

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 422