אפשר לעדכן את הסטטוס של נמען באקטיב טרייל דרך ה-API באחת משתי דרכים. הדרך הקלה ביותר היא בקשת POST, כי לא צריך לקבל קודם את מזהה הנמען.
-
בעזרת בקשת POST (הדרך הקלה ביותר):
בצעו בקשת POST עם כתובת המייל של הנמען כדי לעדכן אותו ישירות, כולל הסטטוס שלו (כל סטטוס, למשל החזרה של נמען בסטטוס מוסר לסטטוס "פעיל"). ה-endpoint מחייב כתובת מייל (פרמטר חובה). לנמען שיש לו רק מספר טלפון נייד (SMS), השתמשו בבקשות GET ו-PUT שבהמשך.
שימו לב: שליחת
subscriptionStatusעם הערךfalseדרך ה-API לא יוצרת נמען בסטטוס מוסר.Endpoint: https://webapi.mymarketing.co.il/api/docs/User/Api/POST-api-contacts
-
בעזרת בקשות GET ו-PUT:
א. בצעו בקשת GET כדי לקבל את כל הנמענים (אפשר להשתמש בפרמטר SEARCH TERM כדי לקבל נמען מסוים בלי לקבל את כולם, אבל שימו לב: אם כתובת המייל של הנמען מכילה סימן פלוס, הוא לא יימצא).
ב. מצאו את המזהה שמשויך לכתובת המייל או למספר ה-SMS של הנמען, ואז עדכנו את הסטטוס בבקשת PUT.
Endpoint: https://webapi.mymarketing.co.il/api/docs/User/Api/PUT-api-contacts-id
בבקשת ה-PUT כללו את מזהה הנמען ואת הסטטוס הרצוי.
שימו לב: בבקשת ה-GET, התאריכים בכתובת מתייחסים למועד שבו הסטטוס של הנמען השתנה לאחרונה. אם לא מזינים תאריכים, מקבלים נמענים שהסטטוס שלהם השתנה ב-3 החודשים האחרונים. מומלץ להזין ב-from_date את התאריך שבו התחלתם לעבוד עם אקטיב טרייל, וב-to_date את התאריך של מחר (תאריך דינמי).