認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
組織 ID を入力する場所
このエンドポイントは、JSONボディのフィールドとして org_id を受け取ります。
組織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