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"
}
Lead Notifications
Create a lead notification
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"
}
Creates a scheduled lead report notification.
Requires a Management API key with
MANAGEMENT_API (or MANAGEMENT_API_SANDBOX) quota, and the LEAD_GENERATION_EMAIL_REPORT_CAN_CREATE_UPDATE permission, sent as the raw Authorization header value — see the Management API overview.string
required
Internal name for the notification.
string
required
Recipient email address(es).
string
CC email address(es).
string
BCC email address(es).
integer
required
One of the
key values from List lead notification frequencies.array
required
Array of
lead_id strings this notification reports on. Write-only — the response reflects the resolved lists under lead_list instead.boolean
default:"true"
Whether the notification is currently enabled.
integer
A connected Slack workspace id, to also deliver via Slack.
array
Slack channel ids to post to, when
slack_workspace is set.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 if the account’s plan has exhausted its lead-notification quota:
403
{ "detail": "You have exhausted your limit of 3 email reports.", "limit": 3 }
Related
- List lead notifications — see what’s already configured.
- List lead notification frequencies — valid
frequencyvalues. - Management API overview — the auth scheme and quota architecture this endpoint is part of.
Authorizations
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.
Response
201
Notification created.
Was this page helpful?