curl --request POST \
--url 'https://api.scanova.io/lead/notification/' \
--header 'Authorization: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"name": "Weekly Trade Show Report",
"to": "sales@example.com",
"cc": "manager@example.com",
"frequency": 3,
"lead_ids": ["L9c2f4a1e"],
"is_active": true
}'
{
"id": 12,
"name": "Weekly Trade Show Report",
"to": "sales@example.com",
"cc": "manager@example.com",
"bcc": null,
"frequency": 3,
"frequency_display": "Once a Week",
"lead_list": [{ "lead_list_name": "Trade Show Signup", "lead_list_id": "L9c2f4a1e" }],
"is_active": true,
"slack_workspace": null,
"slack_channel_ids": null,
"created_by": { "id": 41, "email": "you@example.com" },
"created": "2026-09-08T10:05:00+05:30",
"modified": "2026-09-08T10:05:00+05:30"
}
إشعارات العملاء المحتملين
إنشاء إشعار عملاء محتملين
POST /lead/notification/
POST
/
lead
/
notification
/
curl --request POST \
--url 'https://api.scanova.io/lead/notification/' \
--header 'Authorization: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"name": "Weekly Trade Show Report",
"to": "sales@example.com",
"cc": "manager@example.com",
"frequency": 3,
"lead_ids": ["L9c2f4a1e"],
"is_active": true
}'
{
"id": 12,
"name": "Weekly Trade Show Report",
"to": "sales@example.com",
"cc": "manager@example.com",
"bcc": null,
"frequency": 3,
"frequency_display": "Once a Week",
"lead_list": [{ "lead_list_name": "Trade Show Signup", "lead_list_id": "L9c2f4a1e" }],
"is_active": true,
"slack_workspace": null,
"slack_channel_ids": null,
"created_by": { "id": 41, "email": "you@example.com" },
"created": "2026-09-08T10:05:00+05:30",
"modified": "2026-09-08T10:05:00+05:30"
}
ينشئ إشعار تقرير عملاء محتملين مجدولًا.
يُعاد
يتطلب مفتاح واجهة برمجة تطبيقات إدارة بحصة
MANAGEMENT_API (أو MANAGEMENT_API_SANDBOX) وصلاحية LEAD_GENERATION_EMAIL_REPORT_CAN_CREATE_UPDATE، يُرسَل كقيمة خام لترويسة Authorization — راجع نظرة عامة على واجهة برمجة التطبيقات للإدارة.string
مطلوب
الاسم الداخلي للإشعار.
string
مطلوب
عنوان (عناوين) البريد الإلكتروني للمستلم.
string
عنوان (عناوين) البريد الإلكتروني في نسخة كربونية.
string
عنوان (عناوين) البريد الإلكتروني في نسخة كربونية مخفية.
integer
مطلوب
إحدى قيم
key من سرد ترددات إشعارات العملاء المحتملين.array
مطلوب
مصفوفة من سلاسل
lead_id التي يقدّم هذا الإشعار تقارير عنها. للكتابة فقط — تعكس الاستجابة بدلاً من ذلك القوائم المحلولة تحت lead_list.boolean
افتراضي:"true"
ما إذا كان الإشعار مفعّلًا حاليًا.
integer
معرّف مساحة عمل Slack متصلة، للتسليم أيضًا عبر Slack.
array
معرّفات قنوات Slack التي يُنشَر إليها، عند تعيين
slack_workspace.curl --request POST \
--url 'https://api.scanova.io/lead/notification/' \
--header 'Authorization: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"name": "Weekly Trade Show Report",
"to": "sales@example.com",
"cc": "manager@example.com",
"frequency": 3,
"lead_ids": ["L9c2f4a1e"],
"is_active": true
}'
{
"id": 12,
"name": "Weekly Trade Show Report",
"to": "sales@example.com",
"cc": "manager@example.com",
"bcc": null,
"frequency": 3,
"frequency_display": "Once a Week",
"lead_list": [{ "lead_list_name": "Trade Show Signup", "lead_list_id": "L9c2f4a1e" }],
"is_active": true,
"slack_workspace": null,
"slack_channel_ids": null,
"created_by": { "id": 41, "email": "you@example.com" },
"created": "2026-09-08T10:05:00+05:30",
"modified": "2026-09-08T10:05:00+05:30"
}
403 إذا استُنفدت حصة إشعارات العملاء المحتملين الخاصة بخطة الحساب:
403
{ "detail": "You have exhausted your limit of 3 email reports.", "limit": 3 }
ذو صلة
- سرد إشعارات العملاء المحتملين — رؤية ما هو مُهيَّأ بالفعل.
- سرد ترددات إشعارات العملاء المحتملين — قيم
frequencyالصالحة. - نظرة عامة على واجهة برمجة التطبيقات للإدارة — مخطط المصادقة وبنية الحصص التي ينتمي إليها هذا الطرف.
التفويضات
Send your Management API key as the raw value of the Authorization header — no "Bearer " or "Token " prefix, and no other characters. Example: Authorization: 401f7ac837da42b97f613d789819ff93537bee6a. A header containing more than one space-separated part is rejected outright. Requests also require the request's Host header to be the management API host (e.g. api.scanova.io) — the same key sent to the regular API host will not authenticate.
الاستجابة
201
Notification created.
هل كانت هذه الصفحة مفيدة؟