Campaigns
GET /v1/campaigns/esp
The organisation's own e-mail provider account.
אימות
שלח מפתח API כטוקן Bearer. נקודת קצה זו אינה מציינת הרשאת ספציפית במפרט, לכן הקצה למפתח שלך את המינימום הנדרש ובדוק את התגובה במקום להניח הנחות.
המקום שבו מזהה הארגון שלך נכנס
נקודת קצה זו מקבלת את org_id כפרמטר שאילתת חיפוש. השאר אותו ריק והקריאה תכסה את כל תת-עץ הדיירות שלך; שלח אותו כדי לצמצם את הקריאה לארגון אחד.
מזהה הארגון שלך נמצא במסוף מפתחות ה-API בלוח הבקרה שלך, לצד המפתח עצמו. זהו אותו מזהה בכל קריאה שאתה מבצע.
נסה זאת
החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.
curl -X GET https://api.zinndigital.com/v1/campaigns/esp \
-H "Authorization: Bearer zdk_live_…"מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API
פרטים
Never returns the API key or its Vault path — only the state of the connection and its lifetime delivery counters.
פרמטרים
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
org_id (query) | Uuid | לא | The organization this call acts on. Optional for a caller with exactly one direct membership; **required** for anyone with more than one — which is every reseller and every agen… |
תשובה
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
connected | boolean | כן | — |
id | string | לא | — |
provider | string | כן | — |
status | string<not_connected, unverified, verified, rejected> | כן | — |
from_address | string | לא | — |
from_local_part | string | לא | — |
from_display_name | string | לא | — |
sending_domain | string | לא | — |
reply_to | string | לא | — |
verified_domains | EspVerifiedDomain[] | לא | — |
last_verified_at | string | לא | — |
last_error | string | לא | — |
stats | CampaignDeliveryCounts | לא | ⛔ `sent` is NOT `delivered`. `sent` means a provider accepted the hand-off; `delivered` means the receiving server accepted it, which arrives later by webhook. A screen showing… |
שגיאות שנקודה קצה זו עשויה להחזיר
401 · 403