Instantly

Nutzungsanweisungen

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.

Tools

`instantly_list_leads`

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

Eingabe

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

Ausgabe

Parameter	Typ	Beschreibung
`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.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`leadId`	string	Ja	Lead ID

Ausgabe

Parameter	Typ	Beschreibung
`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.

Eingabe

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

Ausgabe

Parameter	Typ	Beschreibung
`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.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`campaign_id`	string	Nein	Campaign ID to delete leads from. Required if list_id is not provided.
`list_id`	string	Nein	Lead list ID to delete leads from. Required if campaign_id is not provided.
`status`	number	Nein	Optional lead status filter
`ids`	array	Nein	Specific lead IDs to delete
`items`	string	Nein	No description
`limit`	number	Nein	Maximum number of matching leads to delete, up to 10000

Ausgabe

Parameter	Typ	Beschreibung
`count`	number	Number of leads deleted

`instantly_update_lead_interest_status`

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

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`lead_email`	string	Ja	Lead email address
`interest_value`	number	Nein	Interest status value. Leave empty in the block or pass null to reset to Lead.
`campaign_id`	string	Nein	Campaign ID for the lead
`list_id`	string	Nein	Lead list ID for the lead
`ai_interest_value`	number	Nein	AI interest value to set for the lead
`disable_auto_interest`	boolean	Nein	Whether to disable auto interest

Ausgabe

Parameter	Typ	Beschreibung
`message`	string	Background job submission message

`instantly_list_campaigns`

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

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`limit`	number	Nein	Number of campaigns to return, from 1 to 100
`starting_after`	string	Nein	Pagination cursor from next_starting_after
`search`	string	Nein	Search by campaign name
`tag_ids`	string	Nein	Comma-separated campaign tag IDs
`ai_sales_agent_id`	string	Nein	AI Sales Agent ID filter
`status`	number	Nein	Campaign status enum value

Ausgabe

Parameter	Typ	Beschreibung
`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.

Eingabe

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

Ausgabe

Parameter	Typ	Beschreibung
`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.

Eingabe

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

Ausgabe

Parameter	Typ	Beschreibung
`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.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`campaignId`	string	Ja	Campaign ID

Ausgabe

Parameter	Typ	Beschreibung
`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.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`limit`	number	Nein	Number of emails to return, from 1 to 100
`starting_after`	string	Nein	Pagination cursor from next_starting_after
`search`	string	Nein	Search query, email address, or thread:<thread-id>
`campaign_id`	string	Nein	Campaign ID filter
`list_id`	string	Nein	Lead list ID filter
`i_status`	number	Nein	Email interest status filter
`eaccount`	string	Nein	Sending email account filter
`lead`	string	Nein	Lead email address filter
`is_unread`	boolean	Nein	Unread status filter

Ausgabe

Parameter	Typ	Beschreibung
`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.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`eaccount`	string	Ja	Connected email account used to send the reply
`reply_to_uuid`	string	Ja	Email ID to reply to
`subject`	string	Ja	Reply subject
`body`	json	Ja	Reply body object with text and/or html
`cc_address_email_list`	string	Nein	Comma-separated CC email addresses
`bcc_address_email_list`	string	Nein	Comma-separated BCC email addresses

Ausgabe

Parameter	Typ	Beschreibung
`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.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`limit`	number	Nein	Number of lead lists to return, from 1 to 100
`starting_after`	string	Nein	Starting-after timestamp cursor
`has_enrichment_task`	boolean	Nein	Filter by enrichment task setting
`search`	string	Nein	Search query to filter lead lists by name

Ausgabe

Parameter	Typ	Beschreibung
`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.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`name`	string	Ja	Lead list name
`has_enrichment_task`	boolean	Nein	Whether this list runs enrichment for every added lead
`owned_by`	string	Nein	User ID of the lead list owner

Ausgabe

Parameter	Typ	Beschreibung
`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