Campaigns

POST /v1/campaigns/preview

Render a template with example values.

ყველა Campaigns ენდპოინტი

ავტორიზაცია

API გასაღები გაგზავნეთ როგორც bearer token. ეს ენდპოინტი სპეციფიკაციაში არ მიუთითებს კონკრეტულ ნებართვას, ამიტომ მიანიჭეთ თქვენს გასაღებს მინიმალური საჭირო უფლებები და ვარაუდის ნაცვლად შეამოწმეთ პასუხი.

სwhere your organisation id goes-ის ადგილი

ესენდპოინტი იღებს org_id-ს JSON ტანის ველად.

თქვენი ორგანიზაციის ID მითითებულია თქვენი სამართავი პანელის API გასაღებების ეკრანზე, თავად გასაღებთან ახლოს. ის ერთნაირია თქვენ მიერ განხორციელებულ ყველა გამოძახებაში.

სცადეთ

შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.

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-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი 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.

მოთხოვნის სხეული

სახელიტიპისავალდებულორა არის ეს
fallbacksbooleanარა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…
namestringდიახ
subjectstringდიახ
bodystringდიახ
purposestring<marketing, transactional>არა
channelsstring<email, in_app, slack, telegram>[]არა
org_idstringარა

პასუხი

სახელიტიპისავალდებულორა არის ეს
fallbacksbooleanარაWhether this was rendered with fallbacks only, echoed so the composer can label the panel honestly.
subjectstringდიახ
body_textstringდიახ
body_htmlstringდიახ
headersobjectდიახRFC 8058 one-click unsubscribe headers on a marketing message; empty otherwise.

შეცდომები, რომლებიც ამ ენდპოინტს შეუძლია დააბრუნოს

401 · 403 · 422