Campaigns

DELETE /v1/campaigns/{campaignId}

Delete a campaign and retire its delivery rows.

כל נקודות הקצה מסוג Campaigns

אימות

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

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

נסה זאת

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

curl -X DELETE https://api.zinndigital.com/v1/campaigns/{campaignId} \
  -H "Authorization: Bearer zdk_live_…"

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

פרטים

Delete a draft campaign. A campaign that has started sending cannot be deleted — cancel it instead, so its delivery history survives.

פרמטרים

שםסוגנדרשמה זה
campaignId (path)stringכן

תשובה

שםסוגנדרשמה זה
deletedbooleanכן
delivery_rows_purgedintegerכן

שגיאות שנקודה קצה זו עשויה להחזיר

401 · 403 · 404 · 422