Instantly tools
The 12 Instantly operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- 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.
- 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.
- Update leadPATCHChanges a lead: its details, custom variables or interest status, such as marking it interested or meeting booked.
- List accountsGETLists the sending accounts (mailboxes) of the workspace with their email, status and warmup data, up to limit per page. For the next page, pass next_starting_after as starting_after, until it stops coming back.
- List lead listsGETLists the lead lists of the workspace with id and name, 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.
