Tools

Instantly

Manage Instantly leads, campaigns, emails, and lead lists

Usage Instructions

Integrate Instantly API V2 into workflows. 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.

Tools

`instantly_list_leads`

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

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
`count`	number	Number of leads returned
`next_starting_after`	string	Cursor for the next page

`instantly_get_lead`

Retrieves an Instantly V2 lead by ID.

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
`lead`	object	Lead details
`id`	string	Lead ID
`email_address`	string	Lead email address
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`campaign`	string	Campaign ID
`status`	number	Lead status

`instantly_create_lead`

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

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
`lead`	object	Lead details
`id`	string	Lead ID
`email_address`	string	Lead email address
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`campaign`	string	Campaign ID
`status`	number	Lead status

`instantly_patch_lead`

Updates fields on an existing Instantly V2 lead.

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
`lead`	object	Lead details
`id`	string	Lead ID
`email_address`	string	Lead email address
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`campaign`	string	Campaign ID
`status`	number	Lead status

`instantly_delete_leads`

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

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.

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.

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
`campaigns`	array	List of campaigns
`count`	number	Number of campaigns returned
`next_starting_after`	string	Cursor for the next page

`instantly_create_campaign`

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

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
`campaign`	object	Campaign details
`id`	string	Campaign ID
`name`	string	Campaign name
`status`	number	Campaign status

`instantly_patch_campaign`

Updates documented Instantly V2 campaign fields.

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
`campaign`	object	Campaign details
`id`	string	Campaign ID
`name`	string	Campaign name
`status`	number	Campaign status

`instantly_activate_campaign`

Activates, starts, or resumes an Instantly V2 campaign.

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
`campaign`	object	Campaign details
`id`	string	Campaign ID
`name`	string	Campaign name
`status`	number	Campaign status
`message`	string	Confirmation message from Instantly

`instantly_pause_campaign`

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

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
`campaign`	object	Campaign details
`id`	string	Campaign ID
`name`	string	Campaign name
`status`	number	Campaign status
`message`	string	Confirmation message from Instantly

`instantly_delete_campaign`

Permanently deletes an Instantly V2 campaign.

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
`campaign`	object	Campaign details
`id`	string	Campaign ID
`name`	string	Campaign name
`status`	number	Campaign status
`message`	string	Confirmation message from Instantly

`instantly_list_emails`

Retrieves Instantly V2 Unibox emails with search and pagination filters.

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
`emails`	array	List of emails
`count`	number	Number of emails returned
`next_starting_after`	string	Cursor for the next page

`instantly_reply_to_email`

Sends an Instantly V2 reply to an existing Unibox email.

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
`email`	object	Email details
`id`	string	Email ID
`subject`	string	Email subject
`thread_id`	string	Thread ID

`instantly_list_lead_lists`

Retrieves Instantly V2 lead lists with search and pagination filters.

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
`lead_lists`	array	List of lead lists
`count`	number	Number of lead lists returned
`next_starting_after`	string	Cursor for the next page

`instantly_create_lead_list`

Creates an Instantly V2 lead list.

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
`lead_list`	object	Lead list details
`id`	string	Lead list ID
`name`	string	Lead list name

Triggers

`instantly_webhook`

Trigger workflow on any Instantly webhook event

Output

Parameter	Type	Description
`timestamp`	string	ISO timestamp when the event occurred
`eventType`	string	Instantly webhook event type
`workspace`	string	Instantly workspace UUID
`campaignId`	string	Instantly campaign UUID
`campaignName`	string	Instantly campaign name
`leadEmail`	string	Lead email address
`emailAccount`	string	Email account used to send the message
`uniboxUrl`	string	URL to view the conversation in Unibox
`step`	number	Campaign step number, starting at 1
`variant`	number	Campaign step variant number, starting at 1
`isFirst`	boolean	Whether this is the first event of this type
`emailId`	string	Email ID, usable as reply_to_uuid
`emailSubject`	string	Sent email subject
`emailText`	string	Sent email plain-text content
`emailHtml`	string	Sent email HTML content
`replyTextSnippet`	string	Short preview of the reply content
`replySubject`	string	Reply email subject
`replyText`	string	Full plain-text reply content
`replyHtml`	string	Full HTML reply content
`payload`	json	Full Instantly webhook payload, including any extra lead data fields

`instantly_email_sent`

Trigger when Instantly sends an email

Output

Parameter	Type	Description
`timestamp`	string	ISO timestamp when the event occurred
`eventType`	string	Instantly webhook event type
`workspace`	string	Instantly workspace UUID
`campaignId`	string	Instantly campaign UUID
`campaignName`	string	Instantly campaign name
`leadEmail`	string	Lead email address
`emailAccount`	string	Email account used to send the message
`uniboxUrl`	string	URL to view the conversation in Unibox
`step`	number	Campaign step number, starting at 1
`variant`	number	Campaign step variant number, starting at 1
`isFirst`	boolean	Whether this is the first event of this type
`emailId`	string	Email ID, usable as reply_to_uuid
`emailSubject`	string	Sent email subject
`emailText`	string	Sent email plain-text content
`emailHtml`	string	Sent email HTML content
`replyTextSnippet`	string	Short preview of the reply content
`replySubject`	string	Reply email subject
`replyText`	string	Full plain-text reply content
`replyHtml`	string	Full HTML reply content
`payload`	json	Full Instantly webhook payload, including any extra lead data fields

`instantly_email_opened`

Trigger when a lead opens an Instantly email

Output

Parameter	Type	Description
`timestamp`	string	ISO timestamp when the event occurred
`eventType`	string	Instantly webhook event type
`workspace`	string	Instantly workspace UUID
`campaignId`	string	Instantly campaign UUID
`campaignName`	string	Instantly campaign name
`leadEmail`	string	Lead email address
`emailAccount`	string	Email account used to send the message
`uniboxUrl`	string	URL to view the conversation in Unibox
`step`	number	Campaign step number, starting at 1
`variant`	number	Campaign step variant number, starting at 1
`isFirst`	boolean	Whether this is the first event of this type
`emailId`	string	Email ID, usable as reply_to_uuid
`emailSubject`	string	Sent email subject
`emailText`	string	Sent email plain-text content
`emailHtml`	string	Sent email HTML content
`replyTextSnippet`	string	Short preview of the reply content
`replySubject`	string	Reply email subject
`replyText`	string	Full plain-text reply content
`replyHtml`	string	Full HTML reply content
`payload`	json	Full Instantly webhook payload, including any extra lead data fields

`instantly_reply_received`

Trigger when a lead replies to an Instantly email

Output

Parameter	Type	Description
`timestamp`	string	ISO timestamp when the event occurred
`eventType`	string	Instantly webhook event type
`workspace`	string	Instantly workspace UUID
`campaignId`	string	Instantly campaign UUID
`campaignName`	string	Instantly campaign name
`leadEmail`	string	Lead email address
`emailAccount`	string	Email account used to send the message
`uniboxUrl`	string	URL to view the conversation in Unibox
`step`	number	Campaign step number, starting at 1
`variant`	number	Campaign step variant number, starting at 1
`isFirst`	boolean	Whether this is the first event of this type
`emailId`	string	Email ID, usable as reply_to_uuid
`emailSubject`	string	Sent email subject
`emailText`	string	Sent email plain-text content
`emailHtml`	string	Sent email HTML content
`replyTextSnippet`	string	Short preview of the reply content
`replySubject`	string	Reply email subject
`replyText`	string	Full plain-text reply content
`replyHtml`	string	Full HTML reply content
`payload`	json	Full Instantly webhook payload, including any extra lead data fields

`instantly_auto_reply_received`

Trigger when Instantly receives an auto-reply from a lead

Output

Parameter	Type	Description
`timestamp`	string	ISO timestamp when the event occurred
`eventType`	string	Instantly webhook event type
`workspace`	string	Instantly workspace UUID
`campaignId`	string	Instantly campaign UUID
`campaignName`	string	Instantly campaign name
`leadEmail`	string	Lead email address
`emailAccount`	string	Email account used to send the message
`uniboxUrl`	string	URL to view the conversation in Unibox
`step`	number	Campaign step number, starting at 1
`variant`	number	Campaign step variant number, starting at 1
`isFirst`	boolean	Whether this is the first event of this type
`emailId`	string	Email ID, usable as reply_to_uuid
`emailSubject`	string	Sent email subject
`emailText`	string	Sent email plain-text content
`emailHtml`	string	Sent email HTML content
`replyTextSnippet`	string	Short preview of the reply content
`replySubject`	string	Reply email subject
`replyText`	string	Full plain-text reply content
`replyHtml`	string	Full HTML reply content
`payload`	json	Full Instantly webhook payload, including any extra lead data fields

`instantly_link_clicked`

Trigger when a lead clicks a tracked Instantly link

Output

Parameter	Type	Description
`timestamp`	string	ISO timestamp when the event occurred
`eventType`	string	Instantly webhook event type
`workspace`	string	Instantly workspace UUID
`campaignId`	string	Instantly campaign UUID
`campaignName`	string	Instantly campaign name
`leadEmail`	string	Lead email address
`emailAccount`	string	Email account used to send the message
`uniboxUrl`	string	URL to view the conversation in Unibox
`step`	number	Campaign step number, starting at 1
`variant`	number	Campaign step variant number, starting at 1
`isFirst`	boolean	Whether this is the first event of this type
`emailId`	string	Email ID, usable as reply_to_uuid
`emailSubject`	string	Sent email subject
`emailText`	string	Sent email plain-text content
`emailHtml`	string	Sent email HTML content
`replyTextSnippet`	string	Short preview of the reply content
`replySubject`	string	Reply email subject
`replyText`	string	Full plain-text reply content
`replyHtml`	string	Full HTML reply content
`payload`	json	Full Instantly webhook payload, including any extra lead data fields

`instantly_email_bounced`

Trigger when an Instantly email bounces

Output

Parameter	Type	Description
`timestamp`	string	ISO timestamp when the event occurred
`eventType`	string	Instantly webhook event type
`workspace`	string	Instantly workspace UUID
`campaignId`	string	Instantly campaign UUID
`campaignName`	string	Instantly campaign name
`leadEmail`	string	Lead email address
`emailAccount`	string	Email account used to send the message
`uniboxUrl`	string	URL to view the conversation in Unibox
`step`	number	Campaign step number, starting at 1
`variant`	number	Campaign step variant number, starting at 1
`isFirst`	boolean	Whether this is the first event of this type
`emailId`	string	Email ID, usable as reply_to_uuid
`emailSubject`	string	Sent email subject
`emailText`	string	Sent email plain-text content
`emailHtml`	string	Sent email HTML content
`replyTextSnippet`	string	Short preview of the reply content
`replySubject`	string	Reply email subject
`replyText`	string	Full plain-text reply content
`replyHtml`	string	Full HTML reply content
`payload`	json	Full Instantly webhook payload, including any extra lead data fields

`instantly_lead_unsubscribed`

Trigger when an Instantly lead unsubscribes

Output

Parameter	Type	Description
`timestamp`	string	ISO timestamp when the event occurred
`eventType`	string	Instantly webhook event type
`workspace`	string	Instantly workspace UUID
`campaignId`	string	Instantly campaign UUID
`campaignName`	string	Instantly campaign name
`leadEmail`	string	Lead email address
`emailAccount`	string	Email account used to send the message
`uniboxUrl`	string	URL to view the conversation in Unibox
`step`	number	Campaign step number, starting at 1
`variant`	number	Campaign step variant number, starting at 1
`isFirst`	boolean	Whether this is the first event of this type
`emailId`	string	Email ID, usable as reply_to_uuid
`emailSubject`	string	Sent email subject
`emailText`	string	Sent email plain-text content
`emailHtml`	string	Sent email HTML content
`replyTextSnippet`	string	Short preview of the reply content
`replySubject`	string	Reply email subject
`replyText`	string	Full plain-text reply content
`replyHtml`	string	Full HTML reply content
`payload`	json	Full Instantly webhook payload, including any extra lead data fields

`instantly_account_error`

Trigger when Instantly reports an account-level error

Output

Parameter	Type	Description
`timestamp`	string	ISO timestamp when the event occurred
`eventType`	string	Instantly webhook event type
`workspace`	string	Instantly workspace UUID
`campaignId`	string	Instantly campaign UUID
`campaignName`	string	Instantly campaign name
`leadEmail`	string	Lead email address
`emailAccount`	string	Email account used to send the message
`uniboxUrl`	string	URL to view the conversation in Unibox
`step`	number	Campaign step number, starting at 1
`variant`	number	Campaign step variant number, starting at 1
`isFirst`	boolean	Whether this is the first event of this type
`emailId`	string	Email ID, usable as reply_to_uuid
`emailSubject`	string	Sent email subject
`emailText`	string	Sent email plain-text content
`emailHtml`	string	Sent email HTML content
`replyTextSnippet`	string	Short preview of the reply content
`replySubject`	string	Reply email subject
`replyText`	string	Full plain-text reply content
`replyHtml`	string	Full HTML reply content
`payload`	json	Full Instantly webhook payload, including any extra lead data fields

`instantly_campaign_completed`

Trigger when an Instantly campaign completes

Output

Parameter	Type	Description
`timestamp`	string	ISO timestamp when the event occurred
`eventType`	string	Instantly webhook event type
`workspace`	string	Instantly workspace UUID
`campaignId`	string	Instantly campaign UUID
`campaignName`	string	Instantly campaign name
`leadEmail`	string	Lead email address
`emailAccount`	string	Email account used to send the message
`uniboxUrl`	string	URL to view the conversation in Unibox
`step`	number	Campaign step number, starting at 1
`variant`	number	Campaign step variant number, starting at 1
`isFirst`	boolean	Whether this is the first event of this type
`emailId`	string	Email ID, usable as reply_to_uuid
`emailSubject`	string	Sent email subject
`emailText`	string	Sent email plain-text content
`emailHtml`	string	Sent email HTML content
`replyTextSnippet`	string	Short preview of the reply content
`replySubject`	string	Reply email subject
`replyText`	string	Full plain-text reply content
`replyHtml`	string	Full HTML reply content
`payload`	json	Full Instantly webhook payload, including any extra lead data fields

`instantly_lead_neutral`

Trigger when an Instantly lead is marked neutral

Output

Parameter	Type	Description
`timestamp`	string	ISO timestamp when the event occurred
`eventType`	string	Instantly webhook event type
`workspace`	string	Instantly workspace UUID
`campaignId`	string	Instantly campaign UUID
`campaignName`	string	Instantly campaign name
`leadEmail`	string	Lead email address
`emailAccount`	string	Email account used to send the message
`uniboxUrl`	string	URL to view the conversation in Unibox
`step`	number	Campaign step number, starting at 1
`variant`	number	Campaign step variant number, starting at 1
`isFirst`	boolean	Whether this is the first event of this type
`emailId`	string	Email ID, usable as reply_to_uuid
`emailSubject`	string	Sent email subject
`emailText`	string	Sent email plain-text content
`emailHtml`	string	Sent email HTML content
`replyTextSnippet`	string	Short preview of the reply content
`replySubject`	string	Reply email subject
`replyText`	string	Full plain-text reply content
`replyHtml`	string	Full HTML reply content
`payload`	json	Full Instantly webhook payload, including any extra lead data fields

`instantly_lead_interested`

Trigger when an Instantly lead is marked interested

Output

Parameter	Type	Description
`timestamp`	string	ISO timestamp when the event occurred
`eventType`	string	Instantly webhook event type
`workspace`	string	Instantly workspace UUID
`campaignId`	string	Instantly campaign UUID
`campaignName`	string	Instantly campaign name
`leadEmail`	string	Lead email address
`emailAccount`	string	Email account used to send the message
`uniboxUrl`	string	URL to view the conversation in Unibox
`step`	number	Campaign step number, starting at 1
`variant`	number	Campaign step variant number, starting at 1
`isFirst`	boolean	Whether this is the first event of this type
`emailId`	string	Email ID, usable as reply_to_uuid
`emailSubject`	string	Sent email subject
`emailText`	string	Sent email plain-text content
`emailHtml`	string	Sent email HTML content
`replyTextSnippet`	string	Short preview of the reply content
`replySubject`	string	Reply email subject
`replyText`	string	Full plain-text reply content
`replyHtml`	string	Full HTML reply content
`payload`	json	Full Instantly webhook payload, including any extra lead data fields

`instantly_lead_not_interested`

Trigger when an Instantly lead is marked not interested

Output

Parameter	Type	Description
`timestamp`	string	ISO timestamp when the event occurred
`eventType`	string	Instantly webhook event type
`workspace`	string	Instantly workspace UUID
`campaignId`	string	Instantly campaign UUID
`campaignName`	string	Instantly campaign name
`leadEmail`	string	Lead email address
`emailAccount`	string	Email account used to send the message
`uniboxUrl`	string	URL to view the conversation in Unibox
`step`	number	Campaign step number, starting at 1
`variant`	number	Campaign step variant number, starting at 1
`isFirst`	boolean	Whether this is the first event of this type
`emailId`	string	Email ID, usable as reply_to_uuid
`emailSubject`	string	Sent email subject
`emailText`	string	Sent email plain-text content
`emailHtml`	string	Sent email HTML content
`replyTextSnippet`	string	Short preview of the reply content
`replySubject`	string	Reply email subject
`replyText`	string	Full plain-text reply content
`replyHtml`	string	Full HTML reply content
`payload`	json	Full Instantly webhook payload, including any extra lead data fields

`instantly_lead_meeting_booked`

Trigger when an Instantly lead books a meeting

Output

Parameter	Type	Description
`timestamp`	string	ISO timestamp when the event occurred
`eventType`	string	Instantly webhook event type
`workspace`	string	Instantly workspace UUID
`campaignId`	string	Instantly campaign UUID
`campaignName`	string	Instantly campaign name
`leadEmail`	string	Lead email address
`emailAccount`	string	Email account used to send the message
`uniboxUrl`	string	URL to view the conversation in Unibox
`step`	number	Campaign step number, starting at 1
`variant`	number	Campaign step variant number, starting at 1
`isFirst`	boolean	Whether this is the first event of this type
`emailId`	string	Email ID, usable as reply_to_uuid
`emailSubject`	string	Sent email subject
`emailText`	string	Sent email plain-text content
`emailHtml`	string	Sent email HTML content
`replyTextSnippet`	string	Short preview of the reply content
`replySubject`	string	Reply email subject
`replyText`	string	Full plain-text reply content
`replyHtml`	string	Full HTML reply content
`payload`	json	Full Instantly webhook payload, including any extra lead data fields

`instantly_lead_meeting_completed`

Trigger when an Instantly lead completes a meeting

Output

Parameter	Type	Description
`timestamp`	string	ISO timestamp when the event occurred
`eventType`	string	Instantly webhook event type
`workspace`	string	Instantly workspace UUID
`campaignId`	string	Instantly campaign UUID
`campaignName`	string	Instantly campaign name
`leadEmail`	string	Lead email address
`emailAccount`	string	Email account used to send the message
`uniboxUrl`	string	URL to view the conversation in Unibox
`step`	number	Campaign step number, starting at 1
`variant`	number	Campaign step variant number, starting at 1
`isFirst`	boolean	Whether this is the first event of this type
`emailId`	string	Email ID, usable as reply_to_uuid
`emailSubject`	string	Sent email subject
`emailText`	string	Sent email plain-text content
`emailHtml`	string	Sent email HTML content
`replyTextSnippet`	string	Short preview of the reply content
`replySubject`	string	Reply email subject
`replyText`	string	Full plain-text reply content
`replyHtml`	string	Full HTML reply content
`payload`	json	Full Instantly webhook payload, including any extra lead data fields

`instantly_lead_closed`

Trigger when an Instantly lead is marked closed

Output

Parameter	Type	Description
`timestamp`	string	ISO timestamp when the event occurred
`eventType`	string	Instantly webhook event type
`workspace`	string	Instantly workspace UUID
`campaignId`	string	Instantly campaign UUID
`campaignName`	string	Instantly campaign name
`leadEmail`	string	Lead email address
`emailAccount`	string	Email account used to send the message
`uniboxUrl`	string	URL to view the conversation in Unibox
`step`	number	Campaign step number, starting at 1
`variant`	number	Campaign step variant number, starting at 1
`isFirst`	boolean	Whether this is the first event of this type
`emailId`	string	Email ID, usable as reply_to_uuid
`emailSubject`	string	Sent email subject
`emailText`	string	Sent email plain-text content
`emailHtml`	string	Sent email HTML content
`replyTextSnippet`	string	Short preview of the reply content
`replySubject`	string	Reply email subject
`replyText`	string	Full plain-text reply content
`replyHtml`	string	Full HTML reply content
`payload`	json	Full Instantly webhook payload, including any extra lead data fields

`instantly_lead_out_of_office`

Trigger when an Instantly lead is out of office

Output

Parameter	Type	Description
`timestamp`	string	ISO timestamp when the event occurred
`eventType`	string	Instantly webhook event type
`workspace`	string	Instantly workspace UUID
`campaignId`	string	Instantly campaign UUID
`campaignName`	string	Instantly campaign name
`leadEmail`	string	Lead email address
`emailAccount`	string	Email account used to send the message
`uniboxUrl`	string	URL to view the conversation in Unibox
`step`	number	Campaign step number, starting at 1
`variant`	number	Campaign step variant number, starting at 1
`isFirst`	boolean	Whether this is the first event of this type
`emailId`	string	Email ID, usable as reply_to_uuid
`emailSubject`	string	Sent email subject
`emailText`	string	Sent email plain-text content
`emailHtml`	string	Sent email HTML content
`replyTextSnippet`	string	Short preview of the reply content
`replySubject`	string	Reply email subject
`replyText`	string	Full plain-text reply content
`replyHtml`	string	Full HTML reply content
`payload`	json	Full Instantly webhook payload, including any extra lead data fields

`instantly_lead_wrong_person`

Trigger when an Instantly lead is marked wrong person

Output

Parameter	Type	Description
`timestamp`	string	ISO timestamp when the event occurred
`eventType`	string	Instantly webhook event type
`workspace`	string	Instantly workspace UUID
`campaignId`	string	Instantly campaign UUID
`campaignName`	string	Instantly campaign name
`leadEmail`	string	Lead email address
`emailAccount`	string	Email account used to send the message
`uniboxUrl`	string	URL to view the conversation in Unibox
`step`	number	Campaign step number, starting at 1
`variant`	number	Campaign step variant number, starting at 1
`isFirst`	boolean	Whether this is the first event of this type
`emailId`	string	Email ID, usable as reply_to_uuid
`emailSubject`	string	Sent email subject
`emailText`	string	Sent email plain-text content
`emailHtml`	string	Sent email HTML content
`replyTextSnippet`	string	Short preview of the reply content
`replySubject`	string	Reply email subject
`replyText`	string	Full plain-text reply content
`replyHtml`	string	Full HTML reply content
`payload`	json	Full Instantly webhook payload, including any extra lead data fields

`instantly_lead_no_show`

Trigger when an Instantly lead is marked no show

Output

Parameter	Type	Description
`timestamp`	string	ISO timestamp when the event occurred
`eventType`	string	Instantly webhook event type
`workspace`	string	Instantly workspace UUID
`campaignId`	string	Instantly campaign UUID
`campaignName`	string	Instantly campaign name
`leadEmail`	string	Lead email address
`emailAccount`	string	Email account used to send the message
`uniboxUrl`	string	URL to view the conversation in Unibox
`step`	number	Campaign step number, starting at 1
`variant`	number	Campaign step variant number, starting at 1
`isFirst`	boolean	Whether this is the first event of this type
`emailId`	string	Email ID, usable as reply_to_uuid
`emailSubject`	string	Sent email subject
`emailText`	string	Sent email plain-text content
`emailHtml`	string	Sent email HTML content
`replyTextSnippet`	string	Short preview of the reply content
`replySubject`	string	Reply email subject
`replyText`	string	Full plain-text reply content
`replyHtml`	string	Full HTML reply content
`payload`	json	Full Instantly webhook payload, including any extra lead data fields

`instantly_supersearch_enrichment_completed`

Trigger when Instantly completes a Supersearch enrichment

Output

Parameter	Type	Description
`timestamp`	string	ISO timestamp when the event occurred
`eventType`	string	Instantly webhook event type
`workspace`	string	Instantly workspace UUID
`campaignId`	string	Instantly campaign UUID
`campaignName`	string	Instantly campaign name
`leadEmail`	string	Lead email address
`emailAccount`	string	Email account used to send the message
`uniboxUrl`	string	URL to view the conversation in Unibox
`step`	number	Campaign step number, starting at 1
`variant`	number	Campaign step variant number, starting at 1
`isFirst`	boolean	Whether this is the first event of this type
`emailId`	string	Email ID, usable as reply_to_uuid
`emailSubject`	string	Sent email subject
`emailText`	string	Sent email plain-text content
`emailHtml`	string	Sent email HTML content
`replyTextSnippet`	string	Short preview of the reply content
`replySubject`	string	Reply email subject
`replyText`	string	Full plain-text reply content
`replyHtml`	string	Full HTML reply content
`payload`	json	Full Instantly webhook payload, including any extra lead data fields

Notes

Category: tools
Type: instantly

Infisical Intercom

On this page

On this page

Usage Instructions

instantly_list_leads

instantly_get_lead

instantly_create_lead

instantly_patch_lead

instantly_delete_leads

instantly_update_lead_interest_status

instantly_list_campaigns

instantly_create_campaign

instantly_patch_campaign

instantly_activate_campaign

instantly_pause_campaign

instantly_delete_campaign

instantly_list_emails

instantly_reply_to_email

instantly_list_lead_lists

instantly_create_lead_list

instantly_webhook

instantly_email_sent

instantly_email_opened

instantly_reply_received

instantly_auto_reply_received

instantly_link_clicked

instantly_email_bounced

instantly_lead_unsubscribed

instantly_account_error

instantly_campaign_completed

instantly_lead_neutral

instantly_lead_interested

instantly_lead_not_interested

instantly_lead_meeting_booked

instantly_lead_meeting_completed

instantly_lead_closed

instantly_lead_out_of_office

instantly_lead_wrong_person

instantly_lead_no_show

instantly_supersearch_enrichment_completed

Instantly