שליחת קמפיין מייל לקבוצה
תיעוד:
http://webapi.mymarketing.co.il/api/docs/User/Api/POST-api-campaigns
ה-endpoint שלמטה מפושט מאוד (אפשר להוסיף הרבה אובייקטים, כמו בדיקות A/B, עגלות וכו').
הסבר על הפרמטרים:
-
Scheduling: האובייקט הזה חובה. אי אפשר לשלוח את הקמפיין מיד; צריך לתזמן אותו (אפשר לתזמן אותו כמה שניות קדימה, אבל אין כאן send now: true כמו ב-SMS, למשל).
-
Pairs (key, value): מוסבר במאמר נפרד.
-
Group id: היכנסו לקבוצה וחפשו בכתובת הדף "ID=NUMBER".
-
Mailing list id: מוצאים אותו בדומה לקבוצה (השתמשו בו רק אם יש בחשבון רשימת תפוצה).
-
send_test: שליחת מייל ניסיון.
-
Name: שם הקמפיין באקטיב טרייל.
-
Profile id: מוסבר במאמר על פרופילי שליחה, עם הסברים ותמונות על איך למצוא אותו.
-
google_analytics_name: הוסיפו אותו אם רוצים לשלב עם Google Analytics. לא חובה.
-
Subject: נושא (חובה).
-
Preheader: כותרת משנה (לא חובה).
-
predictive_delivery: true: מפעיל שליחה חכמה (predictive delivery) אם התכונה קיימת בחשבון שלכם. אם לא, הסירו אותו.
-
Template id: היכנסו לקמפיינים ← התבניות שלי ← פתחו את התבנית הרצויה וחפשו בכתובת הדף "ID=NUMBER".
-
Content: תוכן הקמפיין, שיכול לכלול HTML. הקפידו להוסיף לוכסן הפוך (\) לפני כל מירכאה בקוד, כדי למנוע שגיאות. אם שולחים גם
contentוגם תבנית, נשלחת התבנית.
שימו לב: אם מוסיפים תוכן, אין צורך בתבנית, ולהפך.
-
content_category_id: נדרש כשהבקשה כוללת גם שליחת ניסיון: בלי שליחת ניסיון ה-endpoint עובד גם בלעדיו, ועם שליחת ניסיון ובלי הפרמטר הזה תתקבל שגיאה. אם משאירים את ערך ברירת המחדל (1), לא תוכלו לשכפל את הקמפיין.
כדי לקבל את המזהה של הקטגוריה, פנו לתמיכה של אקטיב טרייל.
JSON:
{
"scheduling": {
"is_sent": true,
"scheduled_date_utc": "2023-06-01T10:25:12",
"is_limit_to_confirmed": true
},
"pairs": [
{
"Key": "G",
"Value": "3"
}
],
"segment": {
"group_ids": [
105930
]
},
"details": {
"name": "sample string 1",
"subject": "sample string 2",
"user_profile_id": 47800,
"google_analytics_name": "sample string 3",
"content_category_id": 1,
"preheader": "sample string 4"
},
"design": {
"content": "sample string 1",
"language_type": "UTF-8",
"header_footer_language_type": "UTF-8",
"is_add_print_email": true,
"is_auto_css_inliner": true,
"is_remove_system_links": false
},
"template": {
"id": 109273
}
}