Instantly

Instructions d'utilisation

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.

Outils

`instantly_list_leads`

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

Entrée

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

Sortie

Paramètre	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.

Entrée

Paramètre	Type	Obligatoire	Description
`leadId`	string	Oui	Lead ID

Sortie

Paramètre	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.

Entrée

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

Sortie

Paramètre	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.

Entrée

Paramètre	Type	Obligatoire	Description
`campaign_id`	string	Non	Campaign ID to delete leads from. Required if list_id is not provided.
`list_id`	string	Non	Lead list ID to delete leads from. Required if campaign_id is not provided.
`status`	number	Non	Optional lead status filter
`ids`	array	Non	Specific lead IDs to delete
`items`	string	Non	No description
`limit`	number	Non	Maximum number of matching leads to delete, up to 10000

Sortie

Paramètre	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.

Entrée

Paramètre	Type	Obligatoire	Description
`lead_email`	string	Oui	Lead email address
`interest_value`	number	Non	Interest status value. Leave empty in the block or pass null to reset to Lead.
`campaign_id`	string	Non	Campaign ID for the lead
`list_id`	string	Non	Lead list ID for the lead
`ai_interest_value`	number	Non	AI interest value to set for the lead
`disable_auto_interest`	boolean	Non	Whether to disable auto interest

Sortie

Paramètre	Type	Description
`message`	string	Background job submission message

`instantly_list_campaigns`

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

Entrée

Paramètre	Type	Obligatoire	Description
`limit`	number	Non	Number of campaigns to return, from 1 to 100
`starting_after`	string	Non	Pagination cursor from next_starting_after
`search`	string	Non	Search by campaign name
`tag_ids`	string	Non	Comma-separated campaign tag IDs
`ai_sales_agent_id`	string	Non	AI Sales Agent ID filter
`status`	number	Non	Campaign status enum value

Sortie

Paramètre	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.

Entrée

Paramètre	Type	Obligatoire	Description
`name`	string	Oui	Campaign name
`campaign_schedule`	json	Oui	Campaign schedule object with schedules array
`sequences`	array	Non	Campaign sequence definitions
`items`	object	Non	No description
`email_list`	array	Non	Sending email accounts
`items`	string	Non	No description
`daily_limit`	number	Non	Daily sending limit
`daily_max_leads`	number	Non	Daily maximum new leads to contact
`open_tracking`	boolean	Non	Whether to track opens
`stop_on_reply`	boolean	Non	Whether to stop the campaign on reply
`link_tracking`	boolean	Non	Whether to track links
`text_only`	boolean	Non	Whether the campaign is text only
`email_gap`	number	Non	Gap between emails in minutes
`pl_value`	number	Non	Value of every positive lead

Sortie

Paramètre	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.

Entrée

Paramètre	Type	Obligatoire	Description
`campaignId`	string	Oui	Campaign ID
`name`	string	Non	Campaign name
`campaign_schedule`	json	Non	Campaign schedule object with schedules array
`sequences`	array	Non	Campaign sequence definitions
`items`	object	Non	No description
`email_list`	array	Non	Sending email accounts
`items`	string	Non	No description
`daily_limit`	number	Non	Daily sending limit
`daily_max_leads`	number	Non	Daily maximum new leads to contact
`open_tracking`	boolean	Non	Whether to track opens
`stop_on_reply`	boolean	Non	Whether to stop the campaign on reply
`link_tracking`	boolean	Non	Whether to track links
`text_only`	boolean	Non	Whether the campaign is text only
`email_gap`	number	Non	Gap between emails in minutes
`pl_value`	number	Non	Value of every positive lead

Sortie

Paramètre	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.

Entrée

Paramètre	Type	Obligatoire	Description
`campaignId`	string	Oui	Campaign ID

Sortie

Paramètre	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.

Entrée

Paramètre	Type	Obligatoire	Description
`limit`	number	Non	Number of emails to return, from 1 to 100
`starting_after`	string	Non	Pagination cursor from next_starting_after
`search`	string	Non	Search query, email address, or thread:<thread-id>
`campaign_id`	string	Non	Campaign ID filter
`list_id`	string	Non	Lead list ID filter
`i_status`	number	Non	Email interest status filter
`eaccount`	string	Non	Sending email account filter
`lead`	string	Non	Lead email address filter
`is_unread`	boolean	Non	Unread status filter

Sortie

Paramètre	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.

Entrée

Paramètre	Type	Obligatoire	Description
`eaccount`	string	Oui	Connected email account used to send the reply
`reply_to_uuid`	string	Oui	Email ID to reply to
`subject`	string	Oui	Reply subject
`body`	json	Oui	Reply body object with text and/or html
`cc_address_email_list`	string	Non	Comma-separated CC email addresses
`bcc_address_email_list`	string	Non	Comma-separated BCC email addresses

Sortie

Paramètre	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.

Entrée

Paramètre	Type	Obligatoire	Description
`limit`	number	Non	Number of lead lists to return, from 1 to 100
`starting_after`	string	Non	Starting-after timestamp cursor
`has_enrichment_task`	boolean	Non	Filter by enrichment task setting
`search`	string	Non	Search query to filter lead lists by name

Sortie

Paramètre	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.

Entrée

Paramètre	Type	Obligatoire	Description
`name`	string	Oui	Lead list name
`has_enrichment_task`	boolean	Non	Whether this list runs enrichment for every added lead
`owned_by`	string	Non	User ID of the lead list owner

Sortie

Paramètre	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

On this page