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

ParameterTypeRequiredDescription
campaignstringNoCampaign that gets the lead, by the id from List campaigns. Send it or list_id.
list_idstringNoLead list that gets the lead, by the id from List lead lists. Send it or campaign.
emailstringNoEmail of the lead, where the campaign sends.
first_namestringNoFirst name of the lead.
last_namestringNoLast name of the lead.
company_namestringNoCompany of the lead.
job_titlestringNoJob title of the lead.
phonestringNoPhone of the lead.
websitestringNoWebsite of the lead.
personalizationstringNoPersonalized line the email copy can use for this lead.
custom_variablesobjectNoExtra 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_workspacebooleanNoWhen true, skips the lead if its email is already anywhere in the workspace.
skip_if_in_campaignbooleanNoWhen true, skips the lead if it is already in a campaign.
skip_if_in_listbooleanNoWhen 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

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.