احراز هویت
یک کلید API را به عنوان یک توکن برbearer ارسال کنید. این نقطه پایانی مجوز خاصی را در مشخصات خود ذکر نمیکند، بنابراین به جای فرض کردن، حداقل نیازهای کلید خود را بدهید و پاسخ را بررسی کنید.
جایی که شناسه سازمان شما قرار میگیرد
این نقطه پایانی org_id را به عنوان یک فیلد در بدنه JSON دریافت میکند.
شناسه سازمان شما در صفحه کلیدهای API در داشبوردتان، در کنار خود کلید قرار دارد. این شناسه در تمام درخواستهایی که ارسال میکنید یکسان است.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X POST https://api.zinndigital.com/v1/campaigns/templates \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string>, "subject": <string>, "body": <string> }'وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید
جزئیات
The copy enters the auto-translation lifecycle in the same call, so a template is never English-only even for an hour. An unknown magic tag is refused here rather than at send time, because a typo found while sending has no undo.
بدنه درخواست
| نام | نوع | الزامی | چیست |
|---|---|---|---|
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 | خیر | — |
پاسخ
| نام | نوع | الزامی | چیست |
|---|---|---|---|
id | string | بله | — |
org_id | string | بله | — |
name | string | بله | — |
purpose | string<marketing, transactional> | بله | — |
subject | string | بله | — |
body | string | بله | — |
channels | string[] | بله | — |
archived | boolean | بله | — |
created_at | string | بله | — |
updated_at | string | بله | — |
خطاهایی که این نقطه پایانی میتواند برگرداند
401 · 403 · 422