Campaigns

POST `/v1/campaigns/preview`

Render a template with example values.

所有 Campaigns 端点

身份验证

请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限，因此请为您的密钥赋予所需的最小权限，并通过检查响应来确认，而不是盲目假设。

您的组织 ID 应填在此处

此端点接受 org_id 作为 JSON 正文中的一个字段。

您的组织ID位于控制面板的API密钥屏幕上，就在密钥本身的旁边。这是您在每次调用时使用的相同ID。

免费试用

将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。

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 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 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.

请求正文

名称	类型	必填	内容简介
`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`	否	—

响应

名称	类型	必填	内容简介
`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