Iby Instantly
Add leads to a campaign
Adds up to 1,000 leads to one Instantly campaign or lead list, checking their emails against blocklists and existing leads.
Description
Pass `campaign_id` or `list_id`, not both, and a `leads` array; in a campaign every lead needs an `email`, and each lead can carry fields such as `first_name`, `company_name` and `personalization`. `skip_if_in_workspace`, `skip_if_in_campaign` and `skip_if_in_list` skip people you already have, and `verify_leads_on_import` verifies their emails in the background. The key needs the `leads:create` scope (or `leads:all`, `all:create`, `all:all`). Leads added to an active campaign can start receiving its emails, so confirm the campaign first.
add-leads-to-campaign.md
Add leads to a campaign
Adds up to 1,000 leads to one Instantly campaign or lead list, checking their emails against blocklists and existing leads.
Pass campaign_id or list_id, not both, and a leads array; in a campaign
every lead needs an email, and each lead can carry fields such as
first_name, company_name and personalization. skip_if_in_workspace,
skip_if_in_campaign and skip_if_in_list skip people you already have, and
verify_leads_on_import verifies their emails in the background. The key
needs the leads:create scope (or leads:all, all:create, all:all).
Leads added to an active campaign can start receiving its emails, so confirm
the campaign first.
Set up
Use the first option your agent supports.
API (official)
- Base URL: https://api.instantly.ai
- Endpoint:
POST /api/v2/leads/add - Auth: send the header
Authorization: Bearer $INSTANTLY_API_KEY - Get a key: https://app.instantly.ai/app/settings/integrations
- Docs: https://developer.instantly.ai/getting-started/authorization
Before doing anything else, make one read-only call to confirm access.
Rules
- Ask the user before anything that sends messages, costs money, or changes data.
- Never print API keys.
Built from these files in the repository
The layout and the rules come from lib/catalog/render-markdown.ts, the set-up wording from lib/catalog/render-access.ts.
Ways in
| Route | Source | Call | Required | Docs |
|---|---|---|---|---|
| Official | POST /api/v2/leads/add | API key in $INSTANTLY_API_KEY | Docs |