AddLead - הוספת ליד
הפעולה הנפוצה ביותר ב-API - קליטת ליד חדש למערכת. פתוחה (ללא אימות), מזהה שמות שדות בעברית ובאנגלית, וממזגת אוטומטית לידים כפולים.
שלחו POST לכתובת:
POST https://YOUR-SUBDOMAIN.taskey.co.il/webapi/AddLead.php
פורמטים נתמכים: application/json, application/x-www-form-urlencoded, או XML.
פרמטרים עיקריים
| שדה | תיאור | חובה? |
|---|---|---|
name | שם הליד | מומלץ |
phone | טלפון (פורמט ישראלי) | מומלץ מאוד |
email | אימייל | לא |
last_name | שם משפחה | לא |
source | מקור הגעה | מומלץ |
campaign | קמפיין | לא |
adset | קהל יעד | לא |
ad | מודעה | לא |
channel | ערוץ התקשרות (וואטסאפ, שיחה נכנסת, שם דף נחיתה) | לא |
city | עיר | לא |
address | רחוב / כתובת | לא |
description | הערות | לא |
comment | תגובה (מתווספת ללוג) | לא |
status_id | סטטוס (מספר ID) | לא (ברירת מחדל: ליד חדש) |
user_id | נציג משויך (מספר ID) | לא |
Custom1-Custom27 | שדות מותאמים | לא |
שמות חלופיים (Aliases)
ה-API מזהה שמות שדות בעברית ובאנגלית:
| שדה | שמות מקובלים |
|---|---|
| שם | name, שם, שם_פרטי, first_name, Name |
| טלפון | phone, טלפון, נייד, Cli |
| אימייל | email, mail, אימייל, מייל |
| מקור | source, form_name, utm_source |
| קמפיין | campaign, utm_campaign, ref |
| קהל | adset, utm_medium, audience |
| מודעה | ad, utm_content, utm_ad |
💡 טיפ: אם אתם משתמשים בטופס וורדפרס עם שדות בעברית, ה-API יזהה אותם אוטומטית - כולל שדות עם הקידומת
No_Label_שוורדפרס מייצר.
דוגמת בקשה (JSON)
{
"name": "ישראל ישראלי",
"phone": "0501234567",
"email": "israel@example.com",
"source": "אתר",
"campaign": "קמפיין קיץ",
"city": "תל אביב",
"Custom1": "עסק קטן"
}
תשובה (Response)
{
"status": "success",
"message": "lead add",
"lead": {
"id": 12345,
"name": "ישראל ישראלי",
"phone": "0501234567",
"source": "אתר"
}
}
התנהגות בליד כפול
אם ליד עם אותו טלפון כבר קיים:
- ברירת מחדל - הליד הקיים מתעדכן (שדות ריקים מתמלאים, תגובה חדשה נוספת).
- אפשרות "תמיד חדש" - ניתן להפעיל בהגדרות ה-API כדי שתמיד ייווצר ליד חדש.
🛡️ הגנת anti-spam: שליחות זהות לחלוטין תוך דקה נחסמות. מעבר לזה - אין הגבלת קצב מעשית.
חיוב טוקן (אופציונלי)
כברירת מחדל AddLead פתוח - אפשר לשלוח לידים ללא אימות, כדי לא לשבור אינטגרציות קיימות. מי שרוצה לאבטח את ה-endpoint יכול להפעיל בהגדרות ה-API את "לחייב טוקן API בקליטת ליד חדש". כשהאפשרות מופעלת, כל בקשה ל-AddLead חייבת לכלול כותרת Authorization: Bearer YOUR_API_TOKEN תקינה - אחרת היא תידחה עם קוד שגיאה (TOKEN_MISSING / TOKEN_INVALID).
⚠️ שימו לב: הפעלת החיוב תחסום מיד טפסים ואינטגרציות שאינם שולחים טוקן. ודאו שכל מקורות הלידים מעבירים את הטוקן לפני ההפעלה.