Instantly AI
Run Instantly cold email: campaigns and subsequences, leads and lead lists, the Unibox, sending accounts and warmup, analytics, SuperSearch enrichment and webhooks. Connect with an Instantly API key.
- rest
https://api.superagnt.com/v1/connections/instantlyplus the vendor's own path, with your superagnt_ API key asAuthorization: Bearer.- mcp
- Tools named
connection_instantly_*onhttps://mcp.superagnt.com/mcp, served once the account is connected. - billing
- Instantly AI bills your own account. Calls cost no superagnt_ data credits.
- rate limit
- 100 requests a second, 6,000 a minute: the vendor's ceiling as the registry records it, for sizing bursts. Your plan's own limit is on Connections.
- vendor docs
- https://developer.instantly.ai
- sync
- Can copy 9 tables into your workspace database and keep them fresh: the tables.
The Instantly AI connection lets an agent run cold email on Instantly. It creates, starts and pauses campaigns and their subsequences, adds, moves and labels leads and lead lists, reads and answers replies in the Unibox, manages sending accounts and their warmup, reads campaign analytics, runs inbox placement tests, finds and enriches leads with SuperSearch, and registers webhooks for replies, opens, bounces and status changes.
01
Setup
- Create an API key. In your Instantly settings, create an API key with the scopes your agents need (
all:allcovers everything). The connection calls Instantly's API v2. - Connect Instantly AI. In the superagnt app open Integrations, pick Instantly AI, paste the key and press Connect.
02
Things to know
- Lists take
limit(up to 100 on most) andstarting_after: pass each response'snext_starting_afterback for the next page. - Listing leads is a
POST(listLeads), because its filters go in the body: campaign, list, status, ids, search or a smart view. bulkAddLeadsadds up to 1,000 leads to one campaign (campaign_id) or one list (list_id), not both.skip_if_in_workspace,skip_if_in_campaignandskip_if_in_listdrop leads you already have.- Moving leads runs as a background job. Follow it with
connection_instantly_background_jobs_read. - Starting a campaign (
activateCampaign) emails its leads on the campaign's schedule.getCampaignSendingStatusexplains why a campaign is not sending, or is sending slowly. - Some calls spend Instantly credits:
verify_leads_on_import, a lead list'shas_enrichment_task, enrichmentauto_update, enrichment runs and SuperSearch imports. Counting and previewing SuperSearch leads is free. - A done-for-you account order charges the card on file. Send
simulation: truefirst: it returns a quote and places nothing. - Some endpoints have tighter limits than the rest, among them listing Unibox emails (20 a minute), test emails (10 a minute) and domain availability checks (30 a minute).
moveAccountsworks only with the key of an admin workspace, and both workspaces must share that admin workspace.- Starting a campaign, ordering done-for-you accounts, running an enrichment or a SuperSearch import, starting a Google or Microsoft account connect, and creating an API key ask a person first by default. Replies, forwards, test emails, member and sub-workspace invites, changing the workspace owner and every delete always ask. Everything else runs without asking (Permissions).
03
Examples
List campaigns
curl "https://api.superagnt.com/v1/connections/instantly/campaigns?limit=10" \
-H "Authorization: Bearer $AGNTDATA_API_KEY"Add leads to a campaign
curl -X POST "https://api.superagnt.com/v1/connections/instantly/leads/add" \
-H "Authorization: Bearer $AGNTDATA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"campaign_id": "<campaign id>",
"skip_if_in_workspace": true,
"leads": [
{"email": "jenny.rosen@example.com", "first_name": "Jenny", "company_name": "Rosen Labs"}
]
}'Campaign results
curl "https://api.superagnt.com/v1/connections/instantly/campaigns/analytics?id=<campaign id>" \
-H "Authorization: Bearer $AGNTDATA_API_KEY"04
Sync
An Instantly sync copies the Instantly workspace your API key belongs to into your workspace database. Turn it on from the Sync panel on the Instantly AI connection page in the superagnt app; the panel previews the rows and webhook events against your plan before anything starts, and agnt_sync_catalog lists every table and column. How syncs work in general: Vendor sync.
What it copies. By default instantly_campaigns, instantly_campaign_analytics (each campaign's lifetime counters), instantly_campaign_daily_stats, instantly_leads, instantly_replies and instantly_accounts (your sending accounts with their status and warmup score). instantly_sent_emails, instantly_account_daily_stats and instantly_events are off by default; switch them on in Customize.
How updates arrive. The sync registers one Instantly webhook per event, named superagnt_ sync, for replies, interested leads, booked meetings, bounces, unsubscribes, completed campaigns and account errors. A delivery makes the sync re-read the lead, campaign or sending account it names and read new replies, and with instantly_events on it is stored as a row too. Sends, opens, clicks and the other interest labels arrive by polling unless you switch them to webhooks in Customize. Instantly has no change filter for campaigns, leads or sending accounts, so the sync re-reads them in full (leads every 6 hours) and marks what you deleted in Instantly as deleted (leads while the workspace holds at most 5,000).
Plans and keys.
- Instantly's API needs a paid Instantly plan.
- Create the key with
all:all, or with read access to campaigns, leads, emails and accounts plus access to webhooks. A table the key can't read is switched off with a note in the panel. - A key reads one Instantly workspace. To sync another client's Instantly workspace, connect its key in a superagnt_ workspace of its own.
- The sync shares the Instantly workspace's request limits with your agents and your other tools, and paces itself well under them. Listing emails has Instantly's own limit of 20 calls a minute, so a large reply backfill takes a while.
What a Instantly sync copies
A sync copies these tables into your workspace database and keeps them fresh, so an agent reads local rows instead of calling Instantly AI on every run. Turn tables on and off from the Sync panel on the connection. Every table also carries _raw, _hash, _synced_at and _deleted_at. How syncs work: Vendor sync.
beta
_raw column.| Table | What it holds | Default |
|---|---|---|
instantly_campaignsCampaigns | Every campaign with its status, sending settings and sending accounts, re-read every hour and when a campaign completes. | on |
instantly_campaign_analyticsCampaign analytics | Instantly's lifetime counters for every campaign: leads, sends, opens, replies, clicks, bounces, unsubscribes and opportunities. Re-read every hour and when a campaign completes. | on |
instantly_campaign_daily_statsCampaign daily stats | Per campaign and day: sends, leads contacted, opens, replies, clicks and opportunities. The last 7 days are re-read daily because counts land late; a day with no activity is not stored. Kept for 90 days by default. | on |
instantly_leadsLeads | Every lead with its campaign, status, interest and open, reply and click counts. Re-read in full every 6 hours, and re-read when a webhook names it. | on |
instantly_repliesReplies | Emails received in the Unibox in the history window, with their text. Kept current by reply webhooks and a frequent read of the newest; once a day the last 3 days are read again as read marks change. | on |
instantly_sent_emailsSent emails | One row per email sent, with its campaign, step and lead. Off by default: busy senders pass row caps fast. Kept for 90 days by default. | off |
instantly_accountsSending accounts | The sending email accounts with their status, last error, warmup status and score, and daily limit. Re-read every hour and on an account error. | on |
instantly_account_daily_statsAccount daily stats | Per sending account and day: sends, bounces, opens, replies and clicks. The last 7 days are re-read daily. Off by default. Kept for 90 days by default. | off |
instantly_eventsWebhook events | One row per webhook delivery: the only record of single opens and clicks once those events are switched to webhooks. Off by default. Kept for 90 days by default. | off |
63 tools, one per resource and risk
MCP servers and agents on the grouped surface list Instantly AI as these tools. Each takes an action, and the ones that work across record types an object. Every operation also keeps its own per-operation name, in the next table, which works on every server. How grouping works: Grouped tools.
| Tool | Risk | Actions |
|---|---|---|
connection_instantly_campaigns_readRead Instantly campaigns List, get and export campaigns, find the campaigns a lead is in, and see why a campaign is not sending. | read | listgetsearch_by_leadcount_launchedsending_statusexport |
connection_instantly_campaigns_writeCreate and run Instantly campaigns Create, update, start, pause, copy and share campaigns, and add custom variables. Starting (activate) a campaign emails its leads on the campaign's schedule. Test emails: connection_instantly_emails_send. | write | createupdateactivatepauseduplicateadd_variablessharecreate_from_shared |
connection_instantly_campaigns_deleteDelete an Instantly campaign Permanently delete a campaign. | destructive | delete |
connection_instantly_subsequences_readRead Instantly subsequences List and get the subsequences of a campaign (follow-ups that leads enter on a trigger), and see why one is not sending. | read | listgetsending_status |
connection_instantly_subsequences_writeManage Instantly subsequences Create a subsequence that leads enter on a trigger (a reply, a status, a click), update, copy, pause or resume one. A resumed subsequence emails its leads again. | write | createupdateduplicatepauseresume |
connection_instantly_subsequences_deleteDelete an Instantly subsequence Permanently delete a subsequence. | destructive | delete |
connection_instantly_analytics_readRead Instantly campaign analytics Campaign results per campaign, as an overview, per day and per step, and emails sent per day by each sending account. by_campaign and overview take id (one campaign) or ids (a list of campaign ids); omit both for all. | read | by_campaignoverviewdailyby_stepaccount_daily |
connection_instantly_leads_readRead Instantly leads List and filter leads by campaign, list, status, ids, search or smart-view queries, or get one. | read | listget |
connection_instantly_leads_writeAdd and update Instantly leads Add, update, move, copy or assign leads, set their interest status, and move them into or out of a subsequence. Moves run as background jobs (connection_instantly_background_jobs_read). verify_leads_on_import starts email verification of the added leads, which can spend Instantly credits. | write | createaddupdateset_interest_statusmoveassignmove_to_subsequenceremove_from_subsequence |
connection_instantly_leads_deleteDelete Instantly leads Delete leads (one, or in bulk from a campaign or list), or merge a lead into another. | destructive | deletedelete_bulkmerge |
connection_instantly_lead_lists_readRead Instantly lead lists List and get lead lists, and read the email verification counts of a list. | read | listgetverification_stats |
connection_instantly_lead_lists_writeManage Instantly lead lists Create a lead list, or change its name, owner or auto-enrichment. has_enrichment_task enriches every lead added to the list, which can spend Instantly credits. | write | createupdate |
connection_instantly_lead_lists_deleteDelete an Instantly lead list Permanently delete a lead list. | destructive | delete |
connection_instantly_lead_labels_readRead Instantly lead labels List and get lead labels (custom interest statuses), or see the label the AI would give a reply. | read | listgetpredict |
connection_instantly_lead_labels_writeManage Instantly lead labels Create a lead label for an interest status, or update one. | write | createupdate |
connection_instantly_lead_labels_deleteDelete an Instantly lead label Delete a lead label, moving its leads to another status. | destructive | delete |
connection_instantly_block_list_readRead the Instantly block list List, get and download the block list of emails and domains never contacted. | read | listgetdownload |
connection_instantly_block_list_writeBlock emails and domains in Instantly Block an email or domain from outreach, block many at once, or change an entry. | write | blockblock_bulkupdate |
connection_instantly_block_list_deleteUnblock emails and domains in Instantly Remove block list entries: one, up to 1000 by id, or the whole list (or the entries matching a filter). | destructive | unblockunblock_bulkunblock_all |
connection_instantly_email_accounts_readRead Instantly sending accounts List and get sending accounts, the campaigns each sends for, warmup analytics, vitals and tracking-domain checks, and poll a Google or Microsoft connect session. | read | listgetlist_campaignswarmup_analyticstest_vitalstracking_domain_statusconnect_status |
connection_instantly_email_accounts_writeConnect and manage Instantly sending accounts Add an IMAP/SMTP account or start a Google or Microsoft connect (send the user to the returned URL, then poll connect_status), update, pause, resume or mark an account fixed, turn warmup on or off, and move accounts between grouped workspaces. | write | createupdatepauseresumemark_fixedenable_warmupdisable_warmupconnect_googleconnect_microsoftmove |
connection_instantly_email_accounts_deleteDelete an Instantly sending account Permanently delete a sending account. | destructive | delete |
connection_instantly_dfy_orders_readRead Instantly done-for-you orders Read done-for-you (DFY) email account orders and the accounts they bought, and check domains before ordering: availability, similar free domains, and pre-warmed domains for sale. | read | listlist_accountscheck_domainssimilar_domainspre_warmed_domains |
connection_instantly_dfy_orders_buyBuy Instantly email accounts Order done-for-you email accounts on new or pre-warmed domains, or extra accounts on ordered domains. It charges the card on file; simulation: true returns a quote and places nothing. | paid | order |
connection_instantly_dfy_orders_deleteCancel Instantly done-for-you accounts Cancel done-for-you (DFY) accounts you ordered, by email address. | destructive | cancel |
connection_instantly_emails_readRead the Instantly Unibox List and search Unibox emails (replies, sent, scheduled) by campaign, list, lead, account or status, get one, or count unread. | read | listgetcount_unread |
connection_instantly_emails_sendSend Instantly emails Reply to or forward a Unibox email from a sending account (reply_to_uuid is the email id), or send a test email that is not saved to the Unibox. Each one sends real email. | write | replyforwardsend_test |
connection_instantly_emails_writeMark Instantly emails Mark Unibox emails read or unread, mark a whole thread read, or set a reminder on an email. Sending: connection_instantly_emails_send. | write | updatemark_thread_read |
connection_instantly_emails_deleteDelete an Instantly email Permanently delete an email from the Unibox. | destructive | delete |
connection_instantly_supersearch_readSearch Instantly SuperSearch for free Count or preview the leads a SuperSearch query matches, without spending credits. | read | countpreview |
connection_instantly_supersearch_importImport SuperSearch leads into Instantly Spend credits: add the leads of a SuperSearch query to a list and enrich them. | paid | import |
connection_instantly_enrichments_readRead Instantly enrichments Read the enrichments of a lead list or campaign, the AI enrichment running on it, and its past runs. | read | getget_aihistory |
connection_instantly_enrichments_writeSet Instantly enrichment options Spend credits later: set the auto-update options of the enrichment on a lead list or campaign. With auto_update on, every lead added afterwards is enriched, and each enrichment spends Instantly credits. | paid | update_settings |
connection_instantly_enrichments_runRun Instantly enrichments Spend credits: add and run enrichments (work email, LinkedIn profile, verification) or an AI column on a lead list or campaign, or run its enrichments again. | paid | enrichai_enrichrun |
connection_instantly_webhooks_readRead Instantly webhooks List and get webhooks, and the event types they can send. | read | listgetevent_types |
connection_instantly_webhooks_writeManage Instantly webhooks Create or update a webhook that posts events (replies, opens, bounces, status changes) to a URL, send it a test, or resume one disabled by failures. | write | createupdatetestresume |
connection_instantly_webhooks_deleteDelete an Instantly webhook Permanently delete a webhook. | destructive | delete |
connection_instantly_webhook_events_readRead Instantly webhook deliveries List and get the events webhooks delivered, and their success and failure totals overall or per day. | read | listgetsummarysummary_by_date |
connection_instantly_inbox_placement_tests_readRead Instantly inbox placement tests List and get deliverability tests, and the email providers a test can send to. | read | listgetesp_options |
connection_instantly_inbox_placement_tests_writeRun Instantly inbox placement tests Create a deliverability test that emails seed inboxes from your accounts, once or on a schedule, or change its name, schedule or status. | write | createupdate |
connection_instantly_inbox_placement_tests_deleteDelete an Instantly inbox placement test Permanently delete an inbox placement test. | destructive | delete |
connection_instantly_inbox_placement_results_readRead Instantly inbox placement results List and get where each email of a deliverability test landed (inbox, spam or category). | read | listget |
connection_instantly_inbox_placement_stats_readRead Instantly inbox placement stats Inbox, spam and category counts of deliverability tests, overall or per day, and their deliverability insights. | read | by_testby_dateinsights |
connection_instantly_inbox_placement_reports_readRead Instantly blacklist and SpamAssassin reports List and get the blacklist and SpamAssassin reports of deliverability tests. | read | listget |
connection_instantly_workspace_readRead the Instantly workspace Read the workspace, its plan and subscription, and its agency (white-label) domain. | read | getplansubscriptionagency_domain |
connection_instantly_workspace_writeManage the Instantly workspace Rename the workspace or set its logo, or set its agency (white-label) domain. | write | updateset_agency_domain |
connection_instantly_workspace_deleteHand over or strip the Instantly workspace Remove the agency domain, or make another member the owner of the workspace. | destructive | delete_agency_domainchange_owner |
connection_instantly_members_readRead Instantly workspace members List and get the members of the workspace. | read | listget |
connection_instantly_members_writeInvite Instantly workspace members Invite a member with a role, or change a member's role. | write | inviteupdate |
connection_instantly_members_deleteRemove an Instantly workspace member Remove a member from the workspace. | destructive | remove |
connection_instantly_workspace_group_readRead the Instantly workspace group List and get the sub-workspaces of this admin workspace, or get the admin workspace of this one. | read | listgetadmin_workspace |
connection_instantly_workspace_group_writeInvite an Instantly sub-workspace Invite a sub-workspace into this admin workspace. | write | invite |
connection_instantly_workspace_group_deleteRemove an Instantly sub-workspace Remove a sub-workspace from the workspace group. | destructive | remove |
connection_instantly_tags_readRead Instantly custom tags List and get custom tags, and which campaigns and sending accounts carry them. | read | listgetlist_assignments |
connection_instantly_tags_writeManage Instantly custom tags Create or update a custom tag, or add and remove tags on campaigns and sending accounts. | write | createupdateassign |
connection_instantly_tags_deleteDelete an Instantly custom tag Permanently delete a custom tag. | destructive | delete |
connection_instantly_api_keys_readList Instantly API keys List the API keys of the workspace. | read | list |
connection_instantly_api_keys_writeCreate an Instantly API key Create an API key with the scopes it may use. | write | create |
connection_instantly_api_keys_deleteRevoke an Instantly API key Delete (revoke) an API key. | destructive | delete |
connection_instantly_audit_log_readRead the Instantly audit log List audit log events of the workspace. | read | list |
connection_instantly_background_jobs_readRead Instantly background jobs List and get background jobs, such as warmup changes and lead moves, with their progress. | read | listget |
connection_instantly_phone_numbers_readList Instantly phone numbers List the phone numbers of the workspace. | read | list |
connection_instantly_phone_numbers_deleteDelete an Instantly phone number Delete a phone number. | destructive | delete |
All 165 operations
Each operation is a REST path under https://api.superagnt.com/v1/connections/instantly and an MCP tool. The per-operation tool name is the one permissions, approvals and usage records use.
| Operation | MCP tool |
|---|---|
GET /account-campaign-mappings/{email}Get campaigns associated with an email | connection_instantly_getaccountcampaignmappinggrouped: connection_instantly_email_accounts_read, action list_campaigns |
GET /accountsList account | connection_instantly_listaccountgrouped: connection_instantly_email_accounts_read, action list |
POST /accountsCreate account | connection_instantly_createaccountgrouped: connection_instantly_email_accounts_write, action create |
GET /accounts/{email}Get account | connection_instantly_getaccountgrouped: connection_instantly_email_accounts_read, action get |
PATCH /accounts/{email}Patch account | connection_instantly_patchaccountgrouped: connection_instantly_email_accounts_write, action update |
DELETE /accounts/{email}Delete account | connection_instantly_deleteaccountgrouped: connection_instantly_email_accounts_delete, action delete |
POST /accounts/warmup/enableEnable warmup for accounts | connection_instantly_enablewarmupforaccountsgrouped: connection_instantly_email_accounts_write, action enable_warmup |
POST /accounts/warmup/disableDisable warmup for accounts | connection_instantly_disablewarmupforaccountsgrouped: connection_instantly_email_accounts_write, action disable_warmup |
POST /accounts/warmup-analyticsGet warmup analytics | connection_instantly_getwarmupanalyticsgrouped: connection_instantly_email_accounts_read, action warmup_analytics |
GET /accounts/analytics/dailyGet daily account analytics | connection_instantly_getdailyaccountanalyticsgrouped: connection_instantly_analytics_read, action account_daily |
POST /accounts/{email}/pausePause an account | connection_instantly_pauseaccountgrouped: connection_instantly_email_accounts_write, action pause |
POST /accounts/{email}/resumeResume a paused account | connection_instantly_resumeaccountgrouped: connection_instantly_email_accounts_write, action resume |
POST /accounts/{email}/mark-fixedMark an account as fixed | connection_instantly_markaccountfixedgrouped: connection_instantly_email_accounts_write, action mark_fixed |
GET /accounts/ctd/statusGet custom tracking domain status | connection_instantly_getctdstatusgrouped: connection_instantly_email_accounts_read, action tracking_domain_status |
POST /accounts/test/vitalsTest account vitals | connection_instantly_testaccountvitalsgrouped: connection_instantly_email_accounts_read, action test_vitals |
POST /accounts/moveMove accounts between workspaces | connection_instantly_moveaccountsgrouped: connection_instantly_email_accounts_write, action move |
GET /api-keysList api key | connection_instantly_listapikeygrouped: connection_instantly_api_keys_read, action list |
POST /api-keysCreate api key | connection_instantly_createapikeygrouped: connection_instantly_api_keys_write, action create |
DELETE /api-keys/{id}Delete api key | connection_instantly_deleteapikeygrouped: connection_instantly_api_keys_delete, action delete |
GET /audit-logsList audit log | connection_instantly_listauditloggrouped: connection_instantly_audit_log_read, action list |
GET /background-jobsList background job | connection_instantly_listbackgroundjobgrouped: connection_instantly_background_jobs_read, action list |
GET /background-jobs/{id}Get background job | connection_instantly_getbackgroundjobgrouped: connection_instantly_background_jobs_read, action get |
GET /block-lists-entriesList block list entry | connection_instantly_listblocklistentrygrouped: connection_instantly_block_list_read, action list |
POST /block-lists-entriesCreate block list entry | connection_instantly_createblocklistentrygrouped: connection_instantly_block_list_write, action block |
DELETE /block-lists-entriesDelete all block list entries | connection_instantly_deleteallblocklistentrygrouped: connection_instantly_block_list_delete, action unblock_all |
GET /block-lists-entries/{id}Get block list entry | connection_instantly_getblocklistentrygrouped: connection_instantly_block_list_read, action get |
PATCH /block-lists-entries/{id}Patch block list entry | connection_instantly_patchblocklistentrygrouped: connection_instantly_block_list_write, action update |
DELETE /block-lists-entries/{id}Delete block list entry | connection_instantly_deleteblocklistentrygrouped: connection_instantly_block_list_delete, action unblock |
POST /block-lists-entries/bulk-createBulk create block list entry | connection_instantly_createblukblocklistentrygrouped: connection_instantly_block_list_write, action block_bulk |
POST /block-lists-entries/bulk-deleteBulk delete block list entry | connection_instantly_deletebulkblocklistentrygrouped: connection_instantly_block_list_delete, action unblock_bulk |
GET /block-lists-entries/downloadDownload all block list entries as CSV | connection_instantly_downloadblocklistentrygrouped: connection_instantly_block_list_read, action download |
GET /campaignsList campaign | connection_instantly_listcampaigngrouped: connection_instantly_campaigns_read, action list |
POST /campaignsCreate campaign | connection_instantly_createcampaigngrouped: connection_instantly_campaigns_write, action create |
POST /campaigns/{id}/activateActivate(start), or resume a campaign | connection_instantly_activatecampaigngrouped: connection_instantly_campaigns_write, action activate |
POST /campaigns/{id}/pauseStop(or pause) a campaign | connection_instantly_pausecampaigngrouped: connection_instantly_campaigns_write, action pause |
GET /campaigns/{id}Get campaign | connection_instantly_getcampaigngrouped: connection_instantly_campaigns_read, action get |
PATCH /campaigns/{id}Patch campaign | connection_instantly_patchcampaigngrouped: connection_instantly_campaigns_write, action update |
DELETE /campaigns/{id}Delete campaign | connection_instantly_deletecampaigngrouped: connection_instantly_campaigns_delete, action delete |
GET /campaigns/search-by-contactSearch campaigns by lead email | connection_instantly_searchbycontactgrouped: connection_instantly_campaigns_read, action search_by_lead |
GET /campaigns/analyticsGet campaign(s) analytics | connection_instantly_getcampaignanalyticsgrouped: connection_instantly_analytics_read, action by_campaign |
GET /campaigns/analytics/overviewGet campaign(s) analytics overview | connection_instantly_getcampaignanalyticsoverviewgrouped: connection_instantly_analytics_read, action overview |
GET /campaigns/analytics/dailyGet daily campaign analytics | connection_instantly_getdailycampaignanalyticsgrouped: connection_instantly_analytics_read, action daily |
GET /campaigns/analytics/stepsGet campaign steps analytics | connection_instantly_getcampaignstepsanalyticsgrouped: connection_instantly_analytics_read, action by_step |
POST /campaigns/{id}/shareShare a campaign | connection_instantly_sharecampaigngrouped: connection_instantly_campaigns_write, action share |
POST /campaigns/{id}/from-exportCreate campaign from shared one | connection_instantly_createfromexportgrouped: connection_instantly_campaigns_write, action create_from_shared |
POST /campaigns/{id}/exportExport campaign to JSON format | connection_instantly_exportcampaigngrouped: connection_instantly_campaigns_read, action export |
POST /campaigns/{id}/duplicateDuplicate campaign | connection_instantly_duplicategrouped: connection_instantly_campaigns_write, action duplicate |
GET /campaigns/count-launchedGet launched campaigns count | connection_instantly_countlaunchedgrouped: connection_instantly_campaigns_read, action count_launched |
POST /campaigns/{id}/variablesAdd campaign variables | connection_instantly_addvariablesgrouped: connection_instantly_campaigns_write, action add_variables |
GET /campaigns/{id}/sending-statusGet campaign sending status | connection_instantly_getcampaignsendingstatusgrouped: connection_instantly_campaigns_read, action sending_status |
GET /crm-actions/phone-numbersList phone numbers | connection_instantly_listphonenumbersgrouped: connection_instantly_phone_numbers_read, action list |
DELETE /crm-actions/phone-numbers/{id}Delete phone number | connection_instantly_deletephonenumbergrouped: connection_instantly_phone_numbers_delete, action delete |
GET /custom-tag-mappingsList custom tag mapping | connection_instantly_listcustomtagmappinggrouped: connection_instantly_tags_read, action list_assignments |
GET /custom-tagsList custom tag | connection_instantly_listcustomtaggrouped: connection_instantly_tags_read, action list |
POST /custom-tagsCreate custom tag | connection_instantly_createcustomtaggrouped: connection_instantly_tags_write, action create |
GET /custom-tags/{id}Get custom tag | connection_instantly_getcustomtaggrouped: connection_instantly_tags_read, action get |
PATCH /custom-tags/{id}Patch custom tag | connection_instantly_patchcustomtaggrouped: connection_instantly_tags_write, action update |
DELETE /custom-tags/{id}Delete custom tag | connection_instantly_deletecustomtaggrouped: connection_instantly_tags_delete, action delete |
POST /custom-tags/toggle-resourceAssign or unassign tags to resources | connection_instantly_toggletagresourcegrouped: connection_instantly_tags_write, action assign |
GET /dfy-email-account-ordersList dfy email account order | connection_instantly_listdfyemailaccountordergrouped: connection_instantly_dfy_orders_read, action list |
POST /dfy-email-account-ordersPlace a DFY email account order | connection_instantly_createdfyemailaccountordergrouped: connection_instantly_dfy_orders_buy, action order |
POST /dfy-email-account-orders/domains/similarGenerate similar available domains | connection_instantly_generatesimilardomainsgrouped: connection_instantly_dfy_orders_read, action similar_domains |
POST /dfy-email-account-orders/domains/checkCheck domains availability | connection_instantly_checkdomainsavailabilitygrouped: connection_instantly_dfy_orders_read, action check_domains |
POST /dfy-email-account-orders/domains/pre-warmed-up-listGet pre-warmed up domains | connection_instantly_prewarmedupdomainslistgrouped: connection_instantly_dfy_orders_read, action pre_warmed_domains |
GET /dfy-email-account-orders/accountsList DFY ordered email accounts | connection_instantly_listdfyemailaccountordersaccountsgrouped: connection_instantly_dfy_orders_read, action list_accounts |
POST /dfy-email-account-orders/accounts/cancelCancel dfy email accounts | connection_instantly_canceldfyemailaccountsgrouped: connection_instantly_dfy_orders_delete, action cancel |
POST /emails/testSend a test email | connection_instantly_sendtestemailgrouped: connection_instantly_emails_send, action send_test |
POST /emails/replyReply to an email | connection_instantly_replytoemailgrouped: connection_instantly_emails_send, action reply |
POST /emails/forwardForward an email | connection_instantly_forwardemailgrouped: connection_instantly_emails_send, action forward |
GET /emailsList email | connection_instantly_listemailgrouped: connection_instantly_emails_read, action list |
GET /emails/{id}Get email | connection_instantly_getemailgrouped: connection_instantly_emails_read, action get |
PATCH /emails/{id}Patch email | connection_instantly_patchemailgrouped: connection_instantly_emails_write, action update |
DELETE /emails/{id}Delete email | connection_instantly_deleteemailgrouped: connection_instantly_emails_delete, action delete |
GET /emails/unread/countCount unread emails | connection_instantly_countunreademailsgrouped: connection_instantly_emails_read, action count_unread |
POST /emails/threads/{thread_id}/mark-as-readMark all emails in a thread as read | connection_instantly_markthreadasreadgrouped: connection_instantly_emails_write, action mark_thread_read |
GET /inbox-placement-analyticsList inbox placement analytics | connection_instantly_listinboxplacementanalyticsgrouped: connection_instantly_inbox_placement_results_read, action list |
GET /inbox-placement-analytics/{id}Get inbox placement analytics | connection_instantly_getinboxplacementanalyticsgrouped: connection_instantly_inbox_placement_results_read, action get |
POST /inbox-placement-analytics/stats-by-test-idRetrieve inbox placement analytics stats by test id | connection_instantly_getinboxplacementanalyticsstatsbytestidgrouped: connection_instantly_inbox_placement_stats_read, action by_test |
POST /inbox-placement-analytics/deliverability-insightsRetrieve inbox placement analytics deliverability insights | connection_instantly_getinboxplacementanalyticsdelivera_b44fcae0grouped: connection_instantly_inbox_placement_stats_read, action insights |
POST /inbox-placement-analytics/stats-by-dateGet inbox placement analytics stats by date | connection_instantly_getinboxplacementanalyticsstatsbydategrouped: connection_instantly_inbox_placement_stats_read, action by_date |
GET /inbox-placement-reportsList inbox placement blacklist & spamassassin report | connection_instantly_listinboxplacementblacklist_spamas_20872fe2grouped: connection_instantly_inbox_placement_reports_read, action list |
GET /inbox-placement-reports/{id}Get inbox placement blacklist & spamassassin report | connection_instantly_getinboxplacementblacklist_spamass_edd3b6d7grouped: connection_instantly_inbox_placement_reports_read, action get |
GET /inbox-placement-testsList inbox placement test | connection_instantly_listinboxplacementtestgrouped: connection_instantly_inbox_placement_tests_read, action list |
POST /inbox-placement-testsCreate inbox placement test | connection_instantly_createinboxplacementtestgrouped: connection_instantly_inbox_placement_tests_write, action create |
GET /inbox-placement-tests/{id}Get inbox placement test | connection_instantly_getinboxplacementtestgrouped: connection_instantly_inbox_placement_tests_read, action get |
PATCH /inbox-placement-tests/{id}Patch inbox placement test | connection_instantly_patchinboxplacementtestgrouped: connection_instantly_inbox_placement_tests_write, action update |
DELETE /inbox-placement-tests/{id}Delete inbox placement test | connection_instantly_deleteinboxplacementtestgrouped: connection_instantly_inbox_placement_tests_delete, action delete |
GET /inbox-placement-tests/email-service-provider-optionsGet ESP options | connection_instantly_getinboxplacementtestespoptionsgrouped: connection_instantly_inbox_placement_tests_read, action esp_options |
GET /lead-labelsList lead label | connection_instantly_listleadlabelgrouped: connection_instantly_lead_labels_read, action list |
POST /lead-labelsCreate lead label | connection_instantly_createleadlabelgrouped: connection_instantly_lead_labels_write, action create |
GET /lead-labels/{id}Get lead label | connection_instantly_getleadlabelgrouped: connection_instantly_lead_labels_read, action get |
PATCH /lead-labels/{id}Patch lead label | connection_instantly_patchleadlabelgrouped: connection_instantly_lead_labels_write, action update |
DELETE /lead-labels/{id}Delete lead label | connection_instantly_deleteleadlabelgrouped: connection_instantly_lead_labels_delete, action delete |
POST /lead-labels/ai-reply-labelTest AI reply label prediction | connection_instantly_testaireplylabelleadlabelsgrouped: connection_instantly_lead_labels_read, action predict |
GET /lead-listsList lead list | connection_instantly_listleadlistgrouped: connection_instantly_lead_lists_read, action list |
POST /lead-listsCreate lead list | connection_instantly_createleadlistgrouped: connection_instantly_lead_lists_write, action create |
GET /lead-lists/{id}Get lead list | connection_instantly_getleadlistgrouped: connection_instantly_lead_lists_read, action get |
PATCH /lead-lists/{id}Patch lead list | connection_instantly_patchleadlistgrouped: connection_instantly_lead_lists_write, action update |
DELETE /lead-lists/{id}Delete lead list | connection_instantly_deleteleadlistgrouped: connection_instantly_lead_lists_delete, action delete |
GET /lead-lists/{id}/verification-statsGet verification statistics for a lead list | connection_instantly_getverificationstatsgrouped: connection_instantly_lead_lists_read, action verification_stats |
POST /leadsCreate lead | connection_instantly_createleadgrouped: connection_instantly_leads_write, action create |
DELETE /leadsDelete leads in bulk | connection_instantly_bulkdeleteleadsgrouped: connection_instantly_leads_delete, action delete_bulk |
POST /leads/listList leads | connection_instantly_listleadsgrouped: connection_instantly_leads_read, action list |
GET /leads/{id}Get lead | connection_instantly_getleadgrouped: connection_instantly_leads_read, action get |
PATCH /leads/{id}Patch lead | connection_instantly_patchleadgrouped: connection_instantly_leads_write, action update |
DELETE /leads/{id}Delete lead | connection_instantly_deleteleadgrouped: connection_instantly_leads_delete, action delete |
POST /leads/mergeMerge two leads | connection_instantly_mergeleadsgrouped: connection_instantly_leads_delete, action merge |
POST /leads/update-interest-statusUpdate the interest status of a lead | connection_instantly_updateleadintereststatusgrouped: connection_instantly_leads_write, action set_interest_status |
POST /leads/subsequence/removeRemove a lead from a subsequence | connection_instantly_removeleadfromsubsequencegrouped: connection_instantly_leads_write, action remove_from_subsequence |
POST /leads/bulk-assignBulk assign leads to organization users | connection_instantly_bulkassignleadsgrouped: connection_instantly_leads_write, action assign |
POST /leads/moveMove leads to a campaign or list | connection_instantly_moveleadsgrouped: connection_instantly_leads_write, action move |
POST /leads/subsequence/moveMove a lead to a subsequence | connection_instantly_moveleadtosubsequencegrouped: connection_instantly_leads_write, action move_to_subsequence |
POST /leads/addAdd leads in bulk to a campaign or list | connection_instantly_bulkaddleadsgrouped: connection_instantly_leads_write, action add |
POST /oauth/google/initInitialize google oauth | connection_instantly_initgoogleoauthgrouped: connection_instantly_email_accounts_write, action connect_google |
POST /oauth/microsoft/initInitialize microsoft oauth | connection_instantly_initmicrosoftoauthgrouped: connection_instantly_email_accounts_write, action connect_microsoft |
GET /oauth/session/status/{sessionId}Get oauth session status | connection_instantly_getoauthsessionstatusgrouped: connection_instantly_email_accounts_read, action connect_status |
GET /subsequencesList campaign subsequence | connection_instantly_listcampaignsubsequencegrouped: connection_instantly_subsequences_read, action list |
POST /subsequencesCreate campaign subsequence | connection_instantly_createcampaignsubsequencegrouped: connection_instantly_subsequences_write, action create |
POST /subsequences/{id}/duplicateDuplicate a subsequence | connection_instantly_duplicatesubsequencegrouped: connection_instantly_subsequences_write, action duplicate |
POST /subsequences/{id}/pausePause a subsequence | connection_instantly_pausesubsequencegrouped: connection_instantly_subsequences_write, action pause |
POST /subsequences/{id}/resumeResume a paused subsequence | connection_instantly_resumesubsequencegrouped: connection_instantly_subsequences_write, action resume |
GET /subsequences/{id}Get campaign subsequence | connection_instantly_getcampaignsubsequencegrouped: connection_instantly_subsequences_read, action get |
PATCH /subsequences/{id}Patch campaign subsequence | connection_instantly_patchcampaignsubsequencegrouped: connection_instantly_subsequences_write, action update |
DELETE /subsequences/{id}Delete campaign subsequence | connection_instantly_deletecampaignsubsequencegrouped: connection_instantly_subsequences_delete, action delete |
GET /subsequences/{id}/sending-statusGet subsequence sending status | connection_instantly_getsubsequencesendingstatusgrouped: connection_instantly_subsequences_read, action sending_status |
POST /supersearch-enrichment/enrich-leads-from-supersearchEnrich leads from supersearch | connection_instantly_enrichleadsfromsupersearchgrouped: connection_instantly_supersearch_import, action import |
GET /supersearch-enrichment/{resource_id}Get enrichment for resource | connection_instantly_getenrichmentforresourcegrouped: connection_instantly_enrichments_read, action get |
POST /supersearch-enrichmentCreate an enrichment | connection_instantly_createsupersearchenrichmentgrouped: connection_instantly_enrichments_run, action enrich |
PATCH /supersearch-enrichment/{resource_id}/settingsUpdate enrichment settings for resource | connection_instantly_updateenrichmentsettingsforresourcegrouped: connection_instantly_enrichments_write, action update_settings |
POST /supersearch-enrichment/aiCreate AI enrichment | connection_instantly_createaienrichmentgrouped: connection_instantly_enrichments_run, action ai_enrich |
GET /supersearch-enrichment/ai/{resource_id}/in-progressGet AI enrichment for resource | connection_instantly_getaienrichmentforresourcegrouped: connection_instantly_enrichments_read, action get_ai |
GET /supersearch-enrichment/history/{resource_id}Get enrichment history | connection_instantly_getenrichmenthistorygrouped: connection_instantly_enrichments_read, action history |
POST /supersearch-enrichment/runRun enrichment for resource | connection_instantly_runenrichmentgrouped: connection_instantly_enrichments_run, action run |
POST /supersearch-enrichment/count-leads-from-supersearchCount leads from supersearch | connection_instantly_countleadsfromsupersearchgrouped: connection_instantly_supersearch_read, action count |
POST /supersearch-enrichment/preview-leads-from-supersearchPreview leads from supersearch | connection_instantly_previewleadsfromsupersearchgrouped: connection_instantly_supersearch_read, action preview |
GET /webhook-eventsList webhook event | connection_instantly_listwebhookeventgrouped: connection_instantly_webhook_events_read, action list |
GET /webhook-events/{id}Get webhook event | connection_instantly_getwebhookeventgrouped: connection_instantly_webhook_events_read, action get |
GET /webhook-events/summaryGet overview aggregates for webhook events | connection_instantly_getwebhookeventssummarygrouped: connection_instantly_webhook_events_read, action summary |
GET /webhook-events/summary-by-dateGet overview aggregates for webhook events by date | connection_instantly_getwebhookeventssummarybydategrouped: connection_instantly_webhook_events_read, action summary_by_date |
GET /webhooksList webhooks | connection_instantly_listwebhookgrouped: connection_instantly_webhooks_read, action list |
POST /webhooksCreate webhook | connection_instantly_createwebhookgrouped: connection_instantly_webhooks_write, action create |
GET /webhooks/{id}Get webhook | connection_instantly_getwebhookgrouped: connection_instantly_webhooks_read, action get |
PATCH /webhooks/{id}Patch webhook | connection_instantly_patchwebhookgrouped: connection_instantly_webhooks_write, action update |
DELETE /webhooks/{id}Delete webhook | connection_instantly_deletewebhookgrouped: connection_instantly_webhooks_delete, action delete |
GET /webhooks/event-typesList available event types | connection_instantly_listwebhookeventtypesgrouped: connection_instantly_webhooks_read, action event_types |
POST /webhooks/{id}/testTest a webhook | connection_instantly_testwebhookgrouped: connection_instantly_webhooks_write, action test |
POST /webhooks/{id}/resumeResume a webhook | connection_instantly_resumewebhookgrouped: connection_instantly_webhooks_write, action resume |
GET /workspace-billing/plan-detailsGet workspace plan details | connection_instantly_getworkspaceplandetailsgrouped: connection_instantly_workspace_read, action plan |
GET /workspace-billing/subscription-detailsGet workspace subscription details | connection_instantly_getworkspacesubscriptiondetailsgrouped: connection_instantly_workspace_read, action subscription |
GET /workspace-group-membersList workspace group member | connection_instantly_listworkspacegroupmembergrouped: connection_instantly_workspace_group_read, action list |
POST /workspace-group-membersCreate workspace group member | connection_instantly_createworkspacegroupmembergrouped: connection_instantly_workspace_group_write, action invite |
GET /workspace-group-members/{id}Get workspace group member | connection_instantly_getworkspacegroupmembergrouped: connection_instantly_workspace_group_read, action get |
DELETE /workspace-group-members/{id}Delete workspace group member | connection_instantly_deleteworkspacegroupmembergrouped: connection_instantly_workspace_group_delete, action remove |
GET /workspace-group-members/adminGet the current workspace admin workspace | connection_instantly_getadminworkspacegroupmembergrouped: connection_instantly_workspace_group_read, action admin_workspace |
GET /workspace-membersList workspace member | connection_instantly_listworkspacemembergrouped: connection_instantly_members_read, action list |
POST /workspace-membersCreate workspace member | connection_instantly_createworkspacemembergrouped: connection_instantly_members_write, action invite |
GET /workspace-members/{id}Get workspace member | connection_instantly_getworkspacemembergrouped: connection_instantly_members_read, action get |
PATCH /workspace-members/{id}Patch workspace member | connection_instantly_patchworkspacemembergrouped: connection_instantly_members_write, action update |
DELETE /workspace-members/{id}Delete workspace member | connection_instantly_deleteworkspacemembergrouped: connection_instantly_members_delete, action remove |
GET /workspaces/currentGet workspace | connection_instantly_getworkspacegrouped: connection_instantly_workspace_read, action get |
PATCH /workspaces/currentPatch workspace | connection_instantly_patchworkspacegrouped: connection_instantly_workspace_write, action update |
GET /workspaces/current/whitelabel-domainGet organization verified agency domain information | connection_instantly_getworkspacedomaininfogrouped: connection_instantly_workspace_read, action agency_domain |
POST /workspaces/current/whitelabel-domainSet the agency domain for the workspace | connection_instantly_addworkspaceagencydomaingrouped: connection_instantly_workspace_write, action set_agency_domain |
DELETE /workspaces/current/whitelabel-domainDelete organization agency domain | connection_instantly_deleteworkspacedomaingrouped: connection_instantly_workspace_delete, action delete_agency_domain |
POST /workspaces/current/change-ownerChange workspace owner | connection_instantly_changeworkspaceownergrouped: connection_instantly_workspace_delete, action change_owner |