Campaigns

POST `/v1/campaigns/preview`

Render a template with example values.

אימות

שלח מפתח API כטוקן Bearer. נקודת קצה זו אינה מציינת הרשאת ספציפית במפרט, לכן הקצה למפתח שלך את המינימום הנדרש ובדוק את התגובה במקום להניח הנחות.

המקום שבו מזהה הארגון שלך נכנס

נקודת קצה זו מקבלת את org_id כשדה בגוף ה-JSON.

מזהה הארגון שלך נמצא במסוף מפתחות ה-API בלוח הבקרה שלך, לצד המפתח עצמו. זהו אותו מזהה בכל קריאה שאתה מבצע.

נסה זאת

החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.

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 בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-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