Instantly

Use Instantly API v2 to create, update, search, or delete leads, manage their interest status, and organize lead lists. Campaign actions create and update schedules and sequences, then activate, pause, or delete campaigns.

Read Unibox emails and reply from a connected sending account. A workflow can synchronize leads into a campaign, check campaign status, or process replies using the actions below.

Use the block

Create, update, and list leads, manage lead interest status, delete leads in bulk, list, create, patch, activate, pause, and delete campaigns, reply to emails, and manage lead lists.

Actions

Instantly List Leads

Retrieves Instantly V2 leads with search, campaign, list, and pagination filters.

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Instantly API key with the required V2 scopes
search	string	No	Search by first name, last name, or email
filter	string	No	Instantly lead filter value, such as FILTER_VAL_CONTACTED or FILTER_VAL_ACTIVE
campaign	string	No	Campaign ID to filter leads
list_id	string	No	Lead list ID to filter leads
in_campaign	boolean	No	Whether the lead is in a campaign
in_list	boolean	No	Whether the lead is in a list
ids	array	No	Lead IDs to include
excluded_ids	array	No	Lead IDs to exclude
organization_user_ids	array	No	Organization user IDs to filter leads
smart_view_id	string	No	Smart view ID to filter leads
contacts	array	No	Lead email addresses to include
limit	number	No	Number of leads to return, from 1 to 100
starting_after	string	No	Forward pagination cursor from next_starting_after
distinct_contacts	boolean	No	Whether to return distinct contacts
is_website_visitor	boolean	No	Whether the lead is a website visitor
enrichment_status	number	No	Enrichment status filter
esg_code	string	No	Email security gateway code filter

Output

Parameter	Type	Description
leads	array	List of leads (id, email, first_name, last_name, campaign, status)
lead	json	Lead details (id, email, first_name, last_name, company_name, job_title, campaign, status, payload)
campaigns	array	List of campaigns (id, name, status, daily_limit)
campaign	json	Campaign details (id, name, status, daily_limit, daily_max_leads, open_tracking)
emails	array	List of emails (id, subject, from_address_email, lead, thread_id)
email	json	Email details (id, subject, from_address_email, to_address_email_list, thread_id, content_preview)
lead_lists	array	List of lead lists (id, name, has_enrichment_task, timestamp_created)
lead_list	json	Lead list details (id, organization_id, has_enrichment_task, owned_by, name, timestamp_created)
count	number	Returned or affected record count
next_starting_after	string	Cursor for the next page
id	string	Record ID
name	string	Record name
email_address	string	Lead email address
first_name	string	Lead first name
last_name	string	Lead last name
status	number	Lead or campaign status
subject	string	Email subject
thread_id	string	Email thread ID
message	string	Operation message

Instantly Get Lead

Retrieves an Instantly V2 lead by ID.

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Instantly API key with the required V2 scopes
leadId	string	Yes	Lead ID

Output

Parameter	Type	Description
leads	array	List of leads (id, email, first_name, last_name, campaign, status)
lead	json	Lead details (id, email, first_name, last_name, company_name, job_title, campaign, status, payload)
campaigns	array	List of campaigns (id, name, status, daily_limit)
campaign	json	Campaign details (id, name, status, daily_limit, daily_max_leads, open_tracking)
emails	array	List of emails (id, subject, from_address_email, lead, thread_id)
email	json	Email details (id, subject, from_address_email, to_address_email_list, thread_id, content_preview)
lead_lists	array	List of lead lists (id, name, has_enrichment_task, timestamp_created)
lead_list	json	Lead list details (id, organization_id, has_enrichment_task, owned_by, name, timestamp_created)
count	number	Returned or affected record count
next_starting_after	string	Cursor for the next page
id	string	Record ID
name	string	Record name
email_address	string	Lead email address
first_name	string	Lead first name
last_name	string	Lead last name
status	number	Lead or campaign status
subject	string	Email subject
thread_id	string	Email thread ID
message	string	Operation message

Instantly Create Lead

Creates an Instantly V2 lead in a campaign or lead list.

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Instantly API key with the required V2 scopes
campaign	string	No	Campaign ID associated with the lead
list_id	string	No	Lead list ID associated with the lead
email	string	No	Lead email address. Required when adding to a campaign.
first_name	string	No	Lead first name
last_name	string	No	Lead last name
company_name	string	No	Lead company name
job_title	string	No	Lead job title
phone	string	No	Lead phone number
website	string	No	Lead website
personalization	string	No	Lead personalization text
lt_interest_status	number	No	Lead interest status value
pl_value_lead	string	No	Potential value of the lead
assigned_to	string	No	Organization user ID assigned to the lead
skip_if_in_workspace	boolean	No	Skip if the lead already exists in the workspace
skip_if_in_campaign	boolean	No	Skip if the lead already exists in the campaign
skip_if_in_list	boolean	No	Skip if the lead already exists in the list
blocklist_id	string	No	Blocklist ID to check for the lead
verify_leads_for_lead_finder	boolean	No	Whether to verify leads imported from Lead Finder
verify_leads_on_import	boolean	No	Whether to verify leads on import
custom_variables	json	No	Custom variable object with string, number, boolean, or null values

Output

Parameter	Type	Description
leads	array	List of leads (id, email, first_name, last_name, campaign, status)
lead	json	Lead details (id, email, first_name, last_name, company_name, job_title, campaign, status, payload)
campaigns	array	List of campaigns (id, name, status, daily_limit)
campaign	json	Campaign details (id, name, status, daily_limit, daily_max_leads, open_tracking)
emails	array	List of emails (id, subject, from_address_email, lead, thread_id)
email	json	Email details (id, subject, from_address_email, to_address_email_list, thread_id, content_preview)
lead_lists	array	List of lead lists (id, name, has_enrichment_task, timestamp_created)
lead_list	json	Lead list details (id, organization_id, has_enrichment_task, owned_by, name, timestamp_created)
count	number	Returned or affected record count
next_starting_after	string	Cursor for the next page
id	string	Record ID
name	string	Record name
email_address	string	Lead email address
first_name	string	Lead first name
last_name	string	Lead last name
status	number	Lead or campaign status
subject	string	Email subject
thread_id	string	Email thread ID
message	string	Operation message

Instantly Patch Lead

Updates fields on an existing Instantly V2 lead.

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Instantly API key with the required V2 scopes
leadId	string	Yes	Lead ID
first_name	string	No	Lead first name
last_name	string	No	Lead last name
company_name	string	No	Lead company name
job_title	string	No	Lead job title
phone	string	No	Lead phone number
website	string	No	Lead website
personalization	string	No	Lead personalization text
lt_interest_status	number	No	Lead interest status value
pl_value_lead	string	No	Potential value of the lead
assigned_to	string	No	ID of the user assigned to the lead
custom_variables	json	No	Custom variable object with string, number, boolean, or null values

Output

Parameter	Type	Description
leads	array	List of leads (id, email, first_name, last_name, campaign, status)
lead	json	Lead details (id, email, first_name, last_name, company_name, job_title, campaign, status, payload)
campaigns	array	List of campaigns (id, name, status, daily_limit)
campaign	json	Campaign details (id, name, status, daily_limit, daily_max_leads, open_tracking)
emails	array	List of emails (id, subject, from_address_email, lead, thread_id)
email	json	Email details (id, subject, from_address_email, to_address_email_list, thread_id, content_preview)
lead_lists	array	List of lead lists (id, name, has_enrichment_task, timestamp_created)
lead_list	json	Lead list details (id, organization_id, has_enrichment_task, owned_by, name, timestamp_created)
count	number	Returned or affected record count
next_starting_after	string	Cursor for the next page
id	string	Record ID
name	string	Record name
email_address	string	Lead email address
first_name	string	Lead first name
last_name	string	Lead last name
status	number	Lead or campaign status
subject	string	Email subject
thread_id	string	Email thread ID
message	string	Operation message

Instantly Delete Leads

Deletes Instantly V2 leads in bulk from a campaign or lead list.

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Instantly API key with the required V2 scopes
campaign_id	string	No	Campaign ID to delete leads from. Required if list_id is not provided.
list_id	string	No	Lead list ID to delete leads from. Required if campaign_id is not provided.
status	number	No	Optional lead status filter
ids	array	No	Specific lead IDs to delete
limit	number	No	Maximum number of matching leads to delete, up to 10000

Output

Parameter	Type	Description
count	number	Number of leads deleted

Instantly Update Lead Interest Status

Submits an Instantly V2 background job to update a lead interest status.

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Instantly API key with the required V2 scopes
lead_email	string	Yes	Lead email address
interest_value	number	No	Interest status value. Leave empty in the block or pass null to reset to Lead.
campaign_id	string	No	Campaign ID for the lead
list_id	string	No	Lead list ID for the lead
ai_interest_value	number	No	AI interest value to set for the lead
disable_auto_interest	boolean	No	Whether to disable auto interest

Output

Parameter	Type	Description
message	string	Background job submission message

Instantly List Campaigns

Retrieves Instantly V2 campaigns with search, status, tag, and pagination filters.

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Instantly API key with the required V2 scopes
limit	number	No	Number of campaigns to return, from 1 to 100
starting_after	string	No	Pagination cursor from next_starting_after
search	string	No	Search by campaign name
tag_ids	string	No	Comma-separated campaign tag IDs
ai_sales_agent_id	string	No	Filter campaigns by AI Sales Agent ID
status	number	No	Campaign status enum value

Output

Parameter	Type	Description
leads	array	List of leads (id, email, first_name, last_name, campaign, status)
lead	json	Lead details (id, email, first_name, last_name, company_name, job_title, campaign, status, payload)
campaigns	array	List of campaigns (id, name, status, daily_limit)
campaign	json	Campaign details (id, name, status, daily_limit, daily_max_leads, open_tracking)
emails	array	List of emails (id, subject, from_address_email, lead, thread_id)
email	json	Email details (id, subject, from_address_email, to_address_email_list, thread_id, content_preview)
lead_lists	array	List of lead lists (id, name, has_enrichment_task, timestamp_created)
lead_list	json	Lead list details (id, organization_id, has_enrichment_task, owned_by, name, timestamp_created)
count	number	Returned or affected record count
next_starting_after	string	Cursor for the next page
id	string	Record ID
name	string	Record name
email_address	string	Lead email address
first_name	string	Lead first name
last_name	string	Lead last name
status	number	Lead or campaign status
subject	string	Email subject
thread_id	string	Email thread ID
message	string	Operation message

Instantly Create Campaign

Creates an Instantly V2 campaign using the documented campaign schedule schema.

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Instantly API key with the required V2 scopes
name	string	Yes	Campaign name
campaign_schedule	json	Yes	Campaign schedule object with schedules array
sequences	array	No	Campaign sequence definitions
email_list	array	No	Sending email accounts
daily_limit	number	No	Daily sending limit
daily_max_leads	number	No	Daily maximum new leads to contact
open_tracking	boolean	No	Whether to track opens
stop_on_reply	boolean	No	Whether to stop the campaign on reply
link_tracking	boolean	No	Whether to track links
text_only	boolean	No	Whether the campaign is text only
email_gap	number	No	Gap between emails in minutes
pl_value	number	No	Value of every positive lead

Output

Parameter	Type	Description
leads	array	List of leads (id, email, first_name, last_name, campaign, status)
lead	json	Lead details (id, email, first_name, last_name, company_name, job_title, campaign, status, payload)
campaigns	array	List of campaigns (id, name, status, daily_limit)
campaign	json	Campaign details (id, name, status, daily_limit, daily_max_leads, open_tracking)
emails	array	List of emails (id, subject, from_address_email, lead, thread_id)
email	json	Email details (id, subject, from_address_email, to_address_email_list, thread_id, content_preview)
lead_lists	array	List of lead lists (id, name, has_enrichment_task, timestamp_created)
lead_list	json	Lead list details (id, organization_id, has_enrichment_task, owned_by, name, timestamp_created)
count	number	Returned or affected record count
next_starting_after	string	Cursor for the next page
id	string	Record ID
name	string	Record name
email_address	string	Lead email address
first_name	string	Lead first name
last_name	string	Lead last name
status	number	Lead or campaign status
subject	string	Email subject
thread_id	string	Email thread ID
message	string	Operation message

Instantly Patch Campaign

Updates documented Instantly V2 campaign fields.

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Instantly API key with the required V2 scopes
campaignId	string	Yes	Campaign ID
name	string	No	Campaign name
campaign_schedule	json	No	Campaign schedule object with schedules array
sequences	array	No	Campaign sequence definitions
email_list	array	No	Sending email accounts
daily_limit	number	No	Daily sending limit
daily_max_leads	number	No	Daily maximum new leads to contact
open_tracking	boolean	No	Whether to track opens
stop_on_reply	boolean	No	Whether to stop the campaign on reply
link_tracking	boolean	No	Whether to track links
text_only	boolean	No	Whether the campaign is text only
email_gap	number	No	Gap between emails in minutes
pl_value	number	No	Value of every positive lead

Output

Parameter	Type	Description
leads	array	List of leads (id, email, first_name, last_name, campaign, status)
lead	json	Lead details (id, email, first_name, last_name, company_name, job_title, campaign, status, payload)
campaigns	array	List of campaigns (id, name, status, daily_limit)
campaign	json	Campaign details (id, name, status, daily_limit, daily_max_leads, open_tracking)
emails	array	List of emails (id, subject, from_address_email, lead, thread_id)
email	json	Email details (id, subject, from_address_email, to_address_email_list, thread_id, content_preview)
lead_lists	array	List of lead lists (id, name, has_enrichment_task, timestamp_created)
lead_list	json	Lead list details (id, organization_id, has_enrichment_task, owned_by, name, timestamp_created)
count	number	Returned or affected record count
next_starting_after	string	Cursor for the next page
id	string	Record ID
name	string	Record name
email_address	string	Lead email address
first_name	string	Lead first name
last_name	string	Lead last name
status	number	Lead or campaign status
subject	string	Email subject
thread_id	string	Email thread ID
message	string	Operation message

Instantly Activate Campaign

Activates, starts, or resumes an Instantly V2 campaign.

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Instantly API key with the required V2 scopes
campaignId	string	Yes	Campaign ID

Output

Parameter	Type	Description
leads	array	List of leads (id, email, first_name, last_name, campaign, status)
lead	json	Lead details (id, email, first_name, last_name, company_name, job_title, campaign, status, payload)
campaigns	array	List of campaigns (id, name, status, daily_limit)
campaign	json	Campaign details (id, name, status, daily_limit, daily_max_leads, open_tracking)
emails	array	List of emails (id, subject, from_address_email, lead, thread_id)
email	json	Email details (id, subject, from_address_email, to_address_email_list, thread_id, content_preview)
lead_lists	array	List of lead lists (id, name, has_enrichment_task, timestamp_created)
lead_list	json	Lead list details (id, organization_id, has_enrichment_task, owned_by, name, timestamp_created)
count	number	Returned or affected record count
next_starting_after	string	Cursor for the next page
id	string	Record ID
name	string	Record name
email_address	string	Lead email address
first_name	string	Lead first name
last_name	string	Lead last name
status	number	Lead or campaign status
subject	string	Email subject
thread_id	string	Email thread ID
message	string	Operation message

Instantly Pause Campaign

Pauses a running Instantly V2 campaign, stopping further email sends.

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Instantly API key with the required V2 scopes
campaignId	string	Yes	Campaign ID

Output

Parameter	Type	Description
leads	array	List of leads (id, email, first_name, last_name, campaign, status)
lead	json	Lead details (id, email, first_name, last_name, company_name, job_title, campaign, status, payload)
campaigns	array	List of campaigns (id, name, status, daily_limit)
campaign	json	Campaign details (id, name, status, daily_limit, daily_max_leads, open_tracking)
emails	array	List of emails (id, subject, from_address_email, lead, thread_id)
email	json	Email details (id, subject, from_address_email, to_address_email_list, thread_id, content_preview)
lead_lists	array	List of lead lists (id, name, has_enrichment_task, timestamp_created)
lead_list	json	Lead list details (id, organization_id, has_enrichment_task, owned_by, name, timestamp_created)
count	number	Returned or affected record count
next_starting_after	string	Cursor for the next page
id	string	Record ID
name	string	Record name
email_address	string	Lead email address
first_name	string	Lead first name
last_name	string	Lead last name
status	number	Lead or campaign status
subject	string	Email subject
thread_id	string	Email thread ID
message	string	Operation message

Instantly Delete Campaign

Permanently deletes an Instantly V2 campaign.

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Instantly API key with the required V2 scopes
campaignId	string	Yes	Campaign ID

Output

Parameter	Type	Description
leads	array	List of leads (id, email, first_name, last_name, campaign, status)
lead	json	Lead details (id, email, first_name, last_name, company_name, job_title, campaign, status, payload)
campaigns	array	List of campaigns (id, name, status, daily_limit)
campaign	json	Campaign details (id, name, status, daily_limit, daily_max_leads, open_tracking)
emails	array	List of emails (id, subject, from_address_email, lead, thread_id)
email	json	Email details (id, subject, from_address_email, to_address_email_list, thread_id, content_preview)
lead_lists	array	List of lead lists (id, name, has_enrichment_task, timestamp_created)
lead_list	json	Lead list details (id, organization_id, has_enrichment_task, owned_by, name, timestamp_created)
count	number	Returned or affected record count
next_starting_after	string	Cursor for the next page
id	string	Record ID
name	string	Record name
email_address	string	Lead email address
first_name	string	Lead first name
last_name	string	Lead last name
status	number	Lead or campaign status
subject	string	Email subject
thread_id	string	Email thread ID
message	string	Operation message

Instantly List Emails

Retrieves Instantly V2 Unibox emails with search and pagination filters.

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Instantly API key with the required V2 scopes
limit	number	No	Number of emails to return, from 1 to 100
starting_after	string	No	Pagination cursor from next_starting_after
search	string	No	Search query, email address, or thread:<thread-id>
campaign_id	string	No	Campaign ID filter
list_id	string	No	Lead list ID filter
i_status	number	No	Email interest status filter
eaccount	string	No	Sending email account filter
lead	string	No	Lead email address filter
is_unread	boolean	No	Unread status filter

Output

Parameter	Type	Description
leads	array	List of leads (id, email, first_name, last_name, campaign, status)
lead	json	Lead details (id, email, first_name, last_name, company_name, job_title, campaign, status, payload)
campaigns	array	List of campaigns (id, name, status, daily_limit)
campaign	json	Campaign details (id, name, status, daily_limit, daily_max_leads, open_tracking)
emails	array	List of emails (id, subject, from_address_email, lead, thread_id)
email	json	Email details (id, subject, from_address_email, to_address_email_list, thread_id, content_preview)
lead_lists	array	List of lead lists (id, name, has_enrichment_task, timestamp_created)
lead_list	json	Lead list details (id, organization_id, has_enrichment_task, owned_by, name, timestamp_created)
count	number	Returned or affected record count
next_starting_after	string	Cursor for the next page
id	string	Record ID
name	string	Record name
email_address	string	Lead email address
first_name	string	Lead first name
last_name	string	Lead last name
status	number	Lead or campaign status
subject	string	Email subject
thread_id	string	Email thread ID
message	string	Operation message

Instantly Reply To Email

Sends an Instantly V2 reply to an existing Unibox email.

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Instantly API key with the required V2 scopes
eaccount	string	Yes	Connected email account used to send the reply
reply_to_uuid	string	Yes	Email ID to reply to
subject	string	Yes	Reply subject
body	json	Yes	Reply body object with text and/or html
cc_address_email_list	string	No	Comma-separated CC email addresses
bcc_address_email_list	string	No	Comma-separated BCC email addresses

Output

Parameter	Type	Description
leads	array	List of leads (id, email, first_name, last_name, campaign, status)
lead	json	Lead details (id, email, first_name, last_name, company_name, job_title, campaign, status, payload)
campaigns	array	List of campaigns (id, name, status, daily_limit)
campaign	json	Campaign details (id, name, status, daily_limit, daily_max_leads, open_tracking)
emails	array	List of emails (id, subject, from_address_email, lead, thread_id)
email	json	Email details (id, subject, from_address_email, to_address_email_list, thread_id, content_preview)
lead_lists	array	List of lead lists (id, name, has_enrichment_task, timestamp_created)
lead_list	json	Lead list details (id, organization_id, has_enrichment_task, owned_by, name, timestamp_created)
count	number	Returned or affected record count
next_starting_after	string	Cursor for the next page
id	string	Record ID
name	string	Record name
email_address	string	Lead email address
first_name	string	Lead first name
last_name	string	Lead last name
status	number	Lead or campaign status
subject	string	Email subject
thread_id	string	Email thread ID
message	string	Operation message

Instantly List Lead Lists

Retrieves Instantly V2 lead lists with search and pagination filters.

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Instantly API key with the required V2 scopes
limit	number	No	Number of lead lists to return, from 1 to 100
starting_after	string	No	Starting-after timestamp cursor
has_enrichment_task	boolean	No	Filter by enrichment task setting
search	string	No	Search query to filter lead lists by name

Output

Parameter	Type	Description
leads	array	List of leads (id, email, first_name, last_name, campaign, status)
lead	json	Lead details (id, email, first_name, last_name, company_name, job_title, campaign, status, payload)
campaigns	array	List of campaigns (id, name, status, daily_limit)
campaign	json	Campaign details (id, name, status, daily_limit, daily_max_leads, open_tracking)
emails	array	List of emails (id, subject, from_address_email, lead, thread_id)
email	json	Email details (id, subject, from_address_email, to_address_email_list, thread_id, content_preview)
lead_lists	array	List of lead lists (id, name, has_enrichment_task, timestamp_created)
lead_list	json	Lead list details (id, organization_id, has_enrichment_task, owned_by, name, timestamp_created)
count	number	Returned or affected record count
next_starting_after	string	Cursor for the next page
id	string	Record ID
name	string	Record name
email_address	string	Lead email address
first_name	string	Lead first name
last_name	string	Lead last name
status	number	Lead or campaign status
subject	string	Email subject
thread_id	string	Email thread ID
message	string	Operation message

Instantly Create Lead List

Creates an Instantly V2 lead list.

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Instantly API key with the required V2 scopes
name	string	Yes	Lead list name
has_enrichment_task	boolean	No	Whether this list runs enrichment for every added lead
owned_by	string	No	User ID of the lead list owner

Output

Parameter	Type	Description
leads	array	List of leads (id, email, first_name, last_name, campaign, status)
lead	json	Lead details (id, email, first_name, last_name, company_name, job_title, campaign, status, payload)
campaigns	array	List of campaigns (id, name, status, daily_limit)
campaign	json	Campaign details (id, name, status, daily_limit, daily_max_leads, open_tracking)
emails	array	List of emails (id, subject, from_address_email, lead, thread_id)
email	json	Email details (id, subject, from_address_email, to_address_email_list, thread_id, content_preview)
lead_lists	array	List of lead lists (id, name, has_enrichment_task, timestamp_created)
lead_list	json	Lead list details (id, organization_id, has_enrichment_task, owned_by, name, timestamp_created)
count	number	Returned or affected record count
next_starting_after	string	Cursor for the next page
id	string	Record ID
name	string	Record name
email_address	string	Lead email address
first_name	string	Lead first name
last_name	string	Lead last name
status	number	Lead or campaign status
subject	string	Email subject
thread_id	string	Email thread ID
message	string	Operation message