Campaigns

POST `/v1/campaigns/preview`

Render a template with example values.

Autenticación

Envía una clave de API como token de portador. Este endpoint no especifica un permiso concreto en la especificación, así que otorga a tu clave los mínimos privilegios necesarios y comprueba la respuesta en lugar de dar por sentado.

Donde va el ID de tu organización

Este endpoint toma org_id como un campo en el cuerpo JSON.

El id de tu organización se encuentra en la pantalla de claves de API en tu panel de control, junto a la propia clave. Es el mismo id en cada llamada que realices.

Pruébalo

Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.

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

¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API

Detalles

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.

Cuerpo de la solicitud

Nombre	Tipo	Obligatorio	¿Qué es esto?
`fallbacks`	`boolean`	No	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`	Sí	—
`subject`	`string`	Sí	—
`body`	`string`	Sí	—
`purpose`	`string<marketing, transactional>`	No	—
`channels`	`string<email, in_app, slack, telegram>[]`	No	—
`org_id`	`string`	No	—

Respuesta

Nombre	Tipo	Obligatorio	¿Qué es esto?
`fallbacks`	`boolean`	No	Whether this was rendered with fallbacks only, echoed so the composer can label the panel honestly.
`subject`	`string`	Sí	—
`body_text`	`string`	Sí	—
`body_html`	`string`	Sí	—
`headers`	`object`	Sí	RFC 8058 one-click unsubscribe headers on a marketing message; empty otherwise.

Errores que este endpoint puede devolver

401 · 403 · 422