Create campaign with the Instantly API
Creates a campaign as a draft, with its schedule, email steps and sending accounts. Add leads with Create lead and start it with Activate campaign.
- Identifier
- instantly_create_campaign
The request
POST https://connect.reportei.com/api/tools/instantly_create_campaign/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"name": "<name>",
"campaign_schedule": {}
}
}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 |
|---|---|---|---|
| name | string | Yes | Name of the campaign. |
| campaign_schedule | object | Yes | When the campaign sends. |
| sequences | array | No | The email copy, as a single sequence with its steps. Instantly only reads the first item. |
| email_list | array | No | Sending accounts, by the email from List accounts. |
| daily_limit | integer | No | Maximum emails the campaign sends per day. |
| daily_max_leads | integer | No | Maximum new leads contacted per day. |
| email_gap | integer | No | Minutes between two emails of the campaign. |
| stop_on_reply | boolean | No | When true, a lead who replies gets no more steps. |
| stop_on_auto_reply | boolean | No | When true, an automatic reply, like out of office, also stops the lead. |
| stop_for_company | boolean | No | When true, a reply stops every lead of the same company domain. |
| open_tracking | boolean | No | Whether to track opens. |
| link_tracking | boolean | No | Whether to track link clicks. |
| text_only | boolean | No | When true, every email goes as plain text. |
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_campaign. 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.
- 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.
- Create leadPOSTAdds 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.
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.
