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