Run Instantly cold email: sending accounts, campaigns, subsequences, leads, lists, emails, tags, inbox placement and analytics.
Explore 138 workflow actions for Instantly, including account permissions and operation limits.
65 read actions73 write actions
WORKFLOW ACTIONS
What you can configure.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Activate(start), or resume a campaign
Write
Requires one of the following scopes: campaigns:update, campaigns:all, all:update, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add campaign variables
Write
Requires one of the following scopes: campaigns:update, campaigns:all, all:update, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add leads in bulk to a campaign or list
Write
Adds up to 1000 leads to either a campaign or a list.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Assign or unassign tags to resources
Write
This can be used for both accounts and campaigns.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Bulk assign leads to organization users
Write
Bulk assign leads to organization users
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Bulk create block list entries
Write
Requires one of the following scopes: blocklistentries:create, blocklistentries:all, all:create, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Bulk delete block list entries
Write
Requires one of the following scopes: blocklistentries:delete, blocklistentries:all, all:delete, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Check an email verification status
Read
Requires one of the following scopes: emailverifications:read, emailverifications:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Count launched campaigns
Read
Requires one of the following scopes: campaigns:read, campaigns:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Count unread emails
Read
Requires one of the following scopes: emails:read, emails:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Create block list entry
Write
Requires one of the following scopes: blocklistentries:create, blocklistentries:all, all:create, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create campaign
Write
Requires one of the following scopes: campaigns:create, campaigns:all, all:create, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create campaign from export
Write
Requires one of the following scopes: campaigns:create, campaigns:all, all:create, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create campaign subsequence
Write
Requires one of the following scopes: subsequences:create, subsequences:all, all:create, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create custom tag
Write
Requires one of the following scopes: customtags:create, customtags:all, all:create, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create email verification
Write
If an email takes longer than 10 seconds to verify, the endpoint will return the status as pending.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create inbox placement test
Write
Requires one of the following scopes: inboxplacementtests:create, inboxplacementtests:all, all:create, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create lead
Write
Requires one of the following scopes: leads:create, leads:all, all:create, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create lead label
Write
Requires one of the following scopes: lead-labels:create, lead-labels:all, all:create, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create lead list
Write
Requires one of the following scopes: leadlists:create, leadlists:all, all:create, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a saved search
Write
Requires one of the following scopes: supersearchenrichments:delete, supersearchenrichments:all, all:delete, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete account
Write
Requires one of the following scopes: accounts:delete, accounts:all, all:delete, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete all block list entries
Write
Requires one of the following scopes: blocklistentries:delete, blocklistentries:all, all:delete, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete block list entry
Write
Requires one of the following scopes: blocklistentries:delete, blocklistentries:all, all:delete, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete campaign
Write
Requires one of the following scopes: campaigns:delete, campaigns:all, all:delete, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete campaign subsequence
Write
Requires one of the following scopes: subsequences:delete, subsequences:all, all:delete, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete custom tag
Write
Requires one of the following scopes: customtags:delete, customtags:all, all:delete, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete email
Write
Requires one of the following scopes: emails:delete, emails:all, all:delete, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete inbox placement test
Write
Requires one of the following scopes: inboxplacementtests:delete, inboxplacementtests:all, all:delete, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete lead
Write
Requires one of the following scopes: leads:delete, leads:all, all:delete, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete lead label
Write
Requires one of the following scopes: lead-labels:delete, lead-labels:all, all:delete, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete lead list
Write
Requires one of the following scopes: leadlists:delete, leadlists:all, all:delete, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete leads in bulk
Write
Delete multiple leads from a campaign or list based on filters.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete organization agency domain
Write
Requires one of the following scopes: workspaces:update, workspaces:all, all:update, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete phone number
Write
Remove a phone number from the organization.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete workspace group member
Write
Requires one of the following scopes: workspacegroupmembers:delete, workspacegroupmembers:all, all:delete, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete workspace member
Write
Requires one of the following scopes: workspacemembers:delete, workspacemembers:all, all:delete, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Disable warmup for accounts
Write
Initiates a background job to disable warmup for the specified accounts.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Duplicate a subsequence
Write
Duplicate a subsequence with the same trigger conditions Requires one of the following scopes: subsequences:create, subsequences:all, all:create, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Duplicate campaign
Write
Requires one of the following scopes: campaigns:create, campaigns:all, all:create, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Enable warmup for accounts
Write
Initiates a background job to enable warmup for the specified accounts.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Export campaign to JSON format
Write
Requires one of the following scopes: campaigns:read, campaigns:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Facet keywords for a signal category
Read
Return the top matching keyword tokens for a given signal category and keyword field, aggregated from the last 90 days of signal data.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Forward an email
Write
Forward an existing email to another recipient.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Get a saved search
Read
Requires one of the following scopes: supersearchenrichments:read, supersearchenrichments:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get account
Read
Requires one of the following scopes: accounts:read, accounts:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get background job
Read
Requires one of the following scopes: background-jobs:read, background-jobs:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get block list entry
Read
Requires one of the following scopes: blocklistentries:read, blocklistentries:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get campaign
Read
Requires one of the following scopes: campaigns:read, campaigns:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get campaign sending status
Read
Returns sending status data explaining why a campaign may not be sending emails or is sending slower than expected.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get campaign steps analytics
Read
Get campaign steps analytics
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get campaign subsequence
Read
Requires one of the following scopes: subsequences:read, subsequences:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get campaign(s) analytics
Read
Get analytics for one or multiple campaigns.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get campaign(s) analytics overview
Read
Get analytics overview for one or multiple campaigns.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get campaigns associated with an email
Read
Requires one of the following scopes: accountcampaignmappings:read, accountcampaignmappings:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get custom tag
Read
Requires one of the following scopes: customtags:read, customtags:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get custom tracking domain status
Read
Requires one of the following scopes: accounts:read, accounts:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get daily account analytics
Read
Get daily account analytics showing the number of emails sent per day for each email account.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get daily campaign analytics
Read
Get campaign daily analytics
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get domain forwarding
Read
Returns the stored web forwarding configuration for a domain ordered through Instantly.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get email
Read
Requires one of the following scopes: emails:read, emails:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get ESP options
Read
Provides a list of available email service providers for inbox placement tests.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get inbox placement analytics
Read
Requires one of the following scopes: inboxplacementanalytics:read, inboxplacementanalytics:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get inbox placement analytics stats by date
Read
Provides a time series representing the distribution of emails sent to inbox, spam, or category folders for scheduled inbox placement tests.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get inbox placement blacklist and spamassassin report
Read
Requires one of the following scopes: inboxplacementreports:read, inboxplacementreports:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get inbox placement test
Read
Requires one of the following scopes: inboxplacementtests:read, inboxplacementtests:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get lead
Read
Requires one of the following scopes: leads:read, leads:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get lead label
Read
Requires one of the following scopes: lead-labels:read, lead-labels:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get lead list
Read
Requires one of the following scopes: leadlists:read, leadlists:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get organization verified agency domain information
Read
Requires one of the following scopes: workspaces:read, workspaces:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get overview aggregates for webhook events
Read
Get overview aggregates for webhook events including success/failure rates
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get overview aggregates for webhook events by date
Read
Get overview aggregates for webhook events by Date for charts
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get subsequence analytics summary
Read
Returns per-subsequence engagement totals (emails sent, unique opens, unique replies) for the subsequences of a campaign.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get subsequence sending status
Read
Returns sending status data explaining why a subsequence may not be sending emails or is sending slower than expected.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get subsequence step and variant analytics
Read
Returns engagement metrics grouped by zero-based step and variant for one subsequence.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get the current workspace admin workspace
Read
Get the details of the admin workspace of the current workspace
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get verification statistics for a lead list
Read
Get verification statistics for a lead list
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get warmup analytics
Read
Requires one of the following scopes: accounts:read, accounts:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get webhook event
Read
Requires one of the following scopes: webhookevents:read, webhookevents:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get workspace
Read
Get your current workspace details.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get workspace group member
Read
Requires one of the following scopes: workspacegroupmembers:read, workspacegroupmembers:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Get workspace member
Read
Requires one of the following scopes: workspacemembers:read, workspacemembers:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
List accounts
Read
Requires one of the following scopes: accounts:read, accounts:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
List audit log
Read
Requires one of the following scopes: auditlogs:read, auditlogs:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
List background job
Read
Requires one of the following scopes: background-jobs:read, background-jobs:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
List block list entry
Read
Requires one of the following scopes: blocklistentries:read, blocklistentries:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
List campaign subsequence
Read
Requires one of the following scopes: subsequences:read, subsequences:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
List campaigns
Read
Requires one of the following scopes: campaigns:read, campaigns:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
List custom tag
Read
Requires one of the following scopes: customtags:read, customtags:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
List custom tag mapping
Read
Requires one of the following scopes: customtagmappings:read, customtagmappings:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
List email
Read
Rate Limit: This endpoint has a rate limit of 20 requests per minute, unlike other API endpoints.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
List inbox placement analytics
Read
Requires one of the following scopes: inboxplacementanalytics:read, inboxplacementanalytics:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
List inbox placement blacklist and spamassassin report
Read
Requires one of the following scopes: inboxplacementreports:read, inboxplacementreports:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
List inbox placement test
Read
Requires one of the following scopes: inboxplacementtests:read, inboxplacementtests:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
List lead label
Read
Requires one of the following scopes: lead-labels:read, lead-labels:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
List lead list
Read
Requires one of the following scopes: leadlists:read, leadlists:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
List leads
Read
This endpoint is a POST endpoint, instead of GET - a deviation from the REST APIs standards weโre following because of the complex arguments it accepts, which would be too hard to express through.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
List phone numbers
Read
Retrieve all phone numbers associated with the current organization.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
List saved searches
Read
List the workspace's saved SuperSearch queries, newest first.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
List webhook event
Read
Requires one of the following scopes: webhookevents:read, webhookevents:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
List workspace group member
Read
Requires one of the following scopes: workspacegroupmembers:read, workspacegroupmembers:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
List workspace member
Read
Requires one of the following scopes: workspacemembers:read, workspacemembers:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Mark all emails in a thread as read
Write
Requires one of the following scopes: emails:update, emails:all, all:update, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Mark an account as fixed
Write
Sets the account to active and clears leftover error metadata such as statusmessage.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Merge two leads
Write
Merge two leads Requires one of the following scopes: leads:update, leads:all, all:update, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Move a lead to a subsequence
Write
Move a lead to a subsequence Requires one of the following scopes: leads:update, leads:all, all:update, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Move leads to a campaign or list
Write
Move leads to a different campaign or list.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Patch account
Write
Requires one of the following scopes: accounts:update, accounts:all, all:update, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Patch block list entry
Write
Requires one of the following scopes: blocklistentries:update, blocklistentries:all, all:update, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Patch campaign
Write
Requires one of the following scopes: campaigns:update, campaigns:all, all:update, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Patch campaign subsequence
Write
Requires one of the following scopes: subsequences:update, subsequences:all, all:update, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Patch custom tag
Write
Requires one of the following scopes: customtags:update, customtags:all, all:update, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Patch email
Write
Requires one of the following scopes: emails:update, emails:all, all:update, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Patch inbox placement test
Write
Requires one of the following scopes: inboxplacementtests:update, inboxplacementtests:all, all:update, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Patch lead
Write
Requires one of the following scopes: leads:update, leads:all, all:update, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Patch lead label
Write
Requires one of the following scopes: lead-labels:update, lead-labels:all, all:update, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Patch lead list
Write
Requires one of the following scopes: leadlists:update, leadlists:all, all:update, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Patch workspace
Write
Update your current workspace details.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Patch workspace member
Write
Requires one of the following scopes: workspacemembers:update, workspacemembers:all, all:update, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Pause a subsequence
Write
Pause a subsequence Requires one of the following scopes: subsequences:update, subsequences:all, all:update, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Pause an account
Write
Requires one of the following scopes: accounts:update, accounts:all, all:update, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Pause multiple accounts
Write
Pauses up to 100 email accounts in the authenticated workspace.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove a lead from a subsequence
Write
Remove a lead from a subsequence Requires one of the following scopes: leads:update, leads:all, all:update, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove domain forwarding
Write
Removes web forwarding from a domain ordered through Instantly.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Reply to an email
Write
Send a reply to an email.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Resume a paused account
Write
Requires one of the following scopes: accounts:update, accounts:all, all:update, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Resume a paused subsequence
Write
Resume a paused subsequence Requires one of the following scopes: subsequences:update, subsequences:all, all:update, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Provides deliverability insights for a specific inbox placement test Requires one of the following scopes: inboxplacementanalytics:read, inboxplacementanalytics:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Retrieve inbox placement analytics stats by test id
Read
Provides aggregated inbox, spam and category counts for specified test IDs Requires one of the following scopes: inboxplacementanalytics:read, inboxplacementanalytics:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Search campaigns by lead email
Read
Requires one of the following scopes: campaigns:read, campaigns:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
Send a test email
Write
Send a preview/test email without creating an email entity in Unibox.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set domain forwarding
Write
Sets web forwarding on a domain ordered through Instantly.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set the agency domain for the workspace
Write
Requires one of the following scopes: workspaces:update, workspaces:all, all:update, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Share a campaign
Write
Share a campaign.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Stop(or pause) a campaign
Write
Requires one of the following scopes: campaigns:update, campaigns:all, all:update, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Test account vitals
Write
Requires one of the following scopes: accounts:read, accounts:all, all:read, all:all
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update a saved search
Write
Rename a saved search and/or replace its filters.
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update the interest status of a lead
Write
Update the interest status of a lead
Permissions and limits
Account permissions
An Instantly API v2 key with the needed scopes
A repeated request may repeat the external action. Review the previous result before retrying a write.
SETUP
Start with a controlled test.
01Connect the intended account
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
02Review inputs and access
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
03Confirm the result
Inspect step outputs and confirm the result in Instantly. A saved workflow is not a completed provider action.