Instantly

使用说明

Integrate Instantly API V2 into workflows. Create and list leads, manage lead interest status, delete leads in bulk, list and create campaigns, reply to emails, and manage lead lists.

工具

`instantly_list_leads`

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

输入

参数	类型	必填	描述
`search`	string	否	Search by first name, last name, or email
`filter`	string	否	Instantly lead filter value, such as FILTER_VAL_CONTACTED or FILTER_VAL_ACTIVE
`campaign`	string	否	Campaign ID to filter leads
`list_id`	string	否	Lead list ID to filter leads
`in_campaign`	boolean	否	Whether the lead is in a campaign
`in_list`	boolean	否	Whether the lead is in a list
`ids`	array	否	Lead IDs to include
`items`	string	否	No description
`excluded_ids`	array	否	Lead IDs to exclude
`items`	string	否	No description
`organization_user_ids`	array	否	Organization user IDs to filter leads
`items`	string	否	No description
`smart_view_id`	string	否	Smart view ID to filter leads
`contacts`	array	否	Lead email addresses to include
`items`	string	否	No description
`limit`	number	否	Number of leads to return, from 1 to 100
`starting_after`	string	否	Forward pagination cursor from next_starting_after
`distinct_contacts`	boolean	否	Whether to return distinct contacts
`is_website_visitor`	boolean	否	Whether the lead is a website visitor
`enrichment_status`	number	否	Enrichment status filter
`esg_code`	string	否	Email security gateway code filter

输出

参数	类型	描述
`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.

输入

参数	类型	必填	描述
`leadId`	string	是	Lead ID

输出

参数	类型	描述
`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.

输入

参数	类型	必填	描述
`campaign`	string	否	Campaign ID associated with the lead
`list_id`	string	否	Lead list ID associated with the lead
`email`	string	否	Lead email address. Required when adding to a campaign.
`first_name`	string	否	Lead first name
`last_name`	string	否	Lead last name
`company_name`	string	否	Lead company name
`job_title`	string	否	Lead job title
`phone`	string	否	Lead phone number
`website`	string	否	Lead website
`personalization`	string	否	Lead personalization text
`lt_interest_status`	number	否	Lead interest status value
`pl_value_lead`	string	否	Potential value of the lead
`assigned_to`	string	否	Organization user ID assigned to the lead
`skip_if_in_workspace`	boolean	否	Skip if the lead already exists in the workspace
`skip_if_in_campaign`	boolean	否	Skip if the lead already exists in the campaign
`skip_if_in_list`	boolean	否	Skip if the lead already exists in the list
`blocklist_id`	string	否	Blocklist ID to check for the lead
`verify_leads_for_lead_finder`	boolean	否	Whether to verify leads imported from Lead Finder
`verify_leads_on_import`	boolean	否	Whether to verify leads on import
`custom_variables`	json	否	Custom variable object with string, number, boolean, or null values

输出

参数	类型	描述
`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.

输入

参数	类型	必填	描述
`campaign_id`	string	否	Campaign ID to delete leads from. Required if list_id is not provided.
`list_id`	string	否	Lead list ID to delete leads from. Required if campaign_id is not provided.
`status`	number	否	Optional lead status filter
`ids`	array	否	Specific lead IDs to delete
`items`	string	否	No description
`limit`	number	否	Maximum number of matching leads to delete, up to 10000

输出

参数	类型	描述
`count`	number	Number of leads deleted

`instantly_update_lead_interest_status`

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

输入

参数	类型	必填	描述
`lead_email`	string	是	Lead email address
`interest_value`	number	否	Interest status value. Leave empty in the block or pass null to reset to Lead.
`campaign_id`	string	否	Campaign ID for the lead
`list_id`	string	否	Lead list ID for the lead
`ai_interest_value`	number	否	AI interest value to set for the lead
`disable_auto_interest`	boolean	否	Whether to disable auto interest

输出

参数	类型	描述
`message`	string	Background job submission message

`instantly_list_campaigns`

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

输入

参数	类型	必填	描述
`limit`	number	否	Number of campaigns to return, from 1 to 100
`starting_after`	string	否	Pagination cursor from next_starting_after
`search`	string	否	Search by campaign name
`tag_ids`	string	否	Comma-separated campaign tag IDs
`ai_sales_agent_id`	string	否	AI Sales Agent ID filter
`status`	number	否	Campaign status enum value

输出

参数	类型	描述
`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.

输入

参数	类型	必填	描述
`name`	string	是	Campaign name
`campaign_schedule`	json	是	Campaign schedule object with schedules array
`sequences`	array	否	Campaign sequence definitions
`items`	object	否	No description
`email_list`	array	否	Sending email accounts
`items`	string	否	No description
`daily_limit`	number	否	Daily sending limit
`daily_max_leads`	number	否	Daily maximum new leads to contact
`open_tracking`	boolean	否	Whether to track opens
`stop_on_reply`	boolean	否	Whether to stop the campaign on reply
`link_tracking`	boolean	否	Whether to track links
`text_only`	boolean	否	Whether the campaign is text only
`email_gap`	number	否	Gap between emails in minutes
`pl_value`	number	否	Value of every positive lead

输出

参数	类型	描述
`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.

输入

参数	类型	必填	描述
`campaignId`	string	是	Campaign ID
`name`	string	否	Campaign name
`campaign_schedule`	json	否	Campaign schedule object with schedules array
`sequences`	array	否	Campaign sequence definitions
`items`	object	否	No description
`email_list`	array	否	Sending email accounts
`items`	string	否	No description
`daily_limit`	number	否	Daily sending limit
`daily_max_leads`	number	否	Daily maximum new leads to contact
`open_tracking`	boolean	否	Whether to track opens
`stop_on_reply`	boolean	否	Whether to stop the campaign on reply
`link_tracking`	boolean	否	Whether to track links
`text_only`	boolean	否	Whether the campaign is text only
`email_gap`	number	否	Gap between emails in minutes
`pl_value`	number	否	Value of every positive lead

输出

参数	类型	描述
`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.

输入

参数	类型	必填	描述
`campaignId`	string	是	Campaign ID

输出

参数	类型	描述
`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.

输入

参数	类型	必填	描述
`limit`	number	否	Number of emails to return, from 1 to 100
`starting_after`	string	否	Pagination cursor from next_starting_after
`search`	string	否	Search query, email address, or thread:<thread-id>
`campaign_id`	string	否	Campaign ID filter
`list_id`	string	否	Lead list ID filter
`i_status`	number	否	Email interest status filter
`eaccount`	string	否	Sending email account filter
`lead`	string	否	Lead email address filter
`is_unread`	boolean	否	Unread status filter

输出

参数	类型	描述
`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.

输入

参数	类型	必填	描述
`eaccount`	string	是	Connected email account used to send the reply
`reply_to_uuid`	string	是	Email ID to reply to
`subject`	string	是	Reply subject
`body`	json	是	Reply body object with text and/or html
`cc_address_email_list`	string	否	Comma-separated CC email addresses
`bcc_address_email_list`	string	否	Comma-separated BCC email addresses

输出

参数	类型	描述
`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.

输入

参数	类型	必填	描述
`limit`	number	否	Number of lead lists to return, from 1 to 100
`starting_after`	string	否	Starting-after timestamp cursor
`has_enrichment_task`	boolean	否	Filter by enrichment task setting
`search`	string	否	Search query to filter lead lists by name

输出

参数	类型	描述
`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.

输入

参数	类型	必填	描述
`name`	string	是	Lead list name
`has_enrichment_task`	boolean	否	Whether this list runs enrichment for every added lead
`owned_by`	string	否	User ID of the lead list owner

输出

参数	类型	描述
`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

On this page