Create lead with the Instantly API
Adds a lead to a campaign or to a lead list. A lead added to an active campaign enters its sequence and gets emails on the schedule.
- Identifier
- instantly_create_lead
The request
POST https://connect.reportei.com/api/tools/instantly_create_lead/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"campaign": "<campaign>"
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| campaign | string | No | Campaign that gets the lead, by the id from List campaigns. Send it or list_id. |
| list_id | string | No | Lead list that gets the lead, by the id from List lead lists. Send it or campaign. |
| string | No | Email of the lead, where the campaign sends. | |
| first_name | string | No | First name of the lead. |
| last_name | string | No | Last name of the lead. |
| company_name | string | No | Company of the lead. |
| job_title | string | No | Job title of the lead. |
| phone | string | No | Phone of the lead. |
| website | string | No | Website of the lead. |
| personalization | string | No | Personalized line the email copy can use for this lead. |
| custom_variables | object | No | Extra variables of the lead, as text, number or boolean values by name, like {"industry": "Retail"}. The campaign starts accepting the same variable names for its other leads. |
| skip_if_in_workspace | boolean | No | When true, skips the lead if its email is already anywhere in the workspace. |
| skip_if_in_campaign | boolean | No | When true, skips the lead if it is already in a campaign. |
| skip_if_in_list | boolean | No | When true, skips the lead if it is already in a lead list. |
Supported connections
Your customer connects their Instantly account once, with one of the modes below. The same connection serves every tool of the toolkit.
API key
Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/instantly_create_lead. It becomes your agent's tool definition with no conversion.
Other Instantly tools
- List campaignsGETLists the campaigns of the workspace with id, name and status, up to limit per page. For the next page, pass next_starting_after as starting_after, until it stops coming back.
- Get campaignGETReturns a campaign with its status, schedule, sequences (the email steps and their variants), sending accounts in email_list and sending options.
- Create campaignPOSTCreates a campaign as a draft, with its schedule, email steps and sending accounts. Add leads with Create lead and start it with Activate campaign.
- Update campaignPATCHChanges a campaign. Send only the fields to change; sequences and campaign_schedule replace the current ones whole.
- Activate campaignPOSTStarts a draft campaign or resumes a paused one. Instantly then sends the steps to the campaign leads, from the accounts in email_list, inside the schedule.
- Pause campaignPOSTPauses a campaign, so no more emails go out until Activate campaign resumes it.
- Get campaign analyticsGETReturns, per campaign, the leads, contacted, emails sent, opens, replies, link clicks, bounces, unsubscribes, completed leads and opportunities, for one campaign or all of them.
- List leadsPOSTLists leads with their email, names, company, status and interest status, up to limit per page. For the next page, pass next_starting_after as starting_after, until it stops coming back.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
