Instantly

Learn how to use Instantly with Composio

Overview

SLUG: INSTANTLY

Description

Instantly is a platform designed to streamline cold email outreach by automating campaigns, managing leads, and enhancing email deliverability.

Authentication Details

generic_api_key
stringRequired

Connecting to Instantly

Create an auth config

Use the dashboard to create an auth config for the Instantly toolkit. This allows you to connect multiple Instantly accounts to Composio for agents to use.

1

Select App

Navigate to Instantly.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Instantly Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4instantly_auth_config_id = "ac_YOUR_INSTANTLY_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10 # Replace this with a method to retrieve an API key from the user.
11 # Or supply your own.
12 user_api_key = input("[!] Enter API key")
13
14 connection_request = composio.connected_accounts.initiate(
15 user_id=user_id,
16 auth_config_id=auth_config_id,
17 config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Instantly for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, instantly_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Instantly toolkit’s playground

For code examples, see the Tool calling guide and Provider examples.

Tool List

Tool Name: Check Custom Tracking Domain Status

Description

Tool to check Custom Tracking Domain (CTD) status for email accounts. Use to verify SSL configuration and CNAME records for a specified domain/host.

Action Parameters

host
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Activate Campaign

Description

Tool to activate or resume a paused campaign. Use when you need to start sending operations for a specific campaign. Prerequisites: Campaign must have at least one sender account, one lead, email sequences, and schedule configured.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add Leads in Bulk

Description

Tool to add multiple leads in bulk to a campaign or list. Use when you need to import several leads at once to an Instantly campaign or list. Supports duplicate handling options and lead verification.

Action Parameters

blocklist_id
campaign_id
leads
arrayRequired
list_id
skip_if_in_campaign
skip_if_in_list
skip_if_in_workspace
verify
verify_leadfinder

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get API Keys

Description

Tool to retrieve paginated list of API keys for organization. Use when you need to list all API keys with their names, scopes, and timestamps.

Action Parameters

limit
starting_after

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Bulk Assign Leads

Description

Tool to bulk assign leads to organization users. Use when you need to assign multiple leads to specific organization members.

Action Parameters

lead_ids
arrayRequired
organization_user_ids
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Campaigns Analytics Overview

Description

Tool to get analytics overview for one or multiple campaigns. Use when you need comprehensive performance metrics including leads, emails, replies, opens, clicks, and CRM events.

Action Parameters

campaign_status
end_date
expand_crm_events
id
ids
start_date

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Import Campaign from Export

Description

Tool to import a campaign from exported data. Use when you need to recreate a campaign from previously exported configuration.

Action Parameters

campaign_id
stringRequired
campaign_schedule
objectRequired
id
stringRequired
name
stringRequired
organization
stringRequired
status
integerRequired
timestamp_created
stringRequired
timestamp_updated
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Check DFY Email Account Order Domains

Description

Tool to check domain availability for DFY email account orders. Use when you need to validate domains before creating DFY email account orders.

Action Parameters

domains
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Check Email Verification Status

Description

Tool to check status of an email verification job. Use after submitting a verification request to retrieve the current status of a specific email address.

Action Parameters

email
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Count Launched Campaigns

Description

Tool to retrieve the count of launched campaigns. Use when you need to know the total number of campaigns that have been launched in the workspace.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Count Leads from SuperSearch

Description

Tool to count leads matching supersearch filter criteria. Use when you need to preview how many leads match your search criteria before creating an enrichment job.

Action Parameters

limit
search_filters
objectRequired
skip_already_owned

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Count Unread Emails

Description

Tool to retrieve the count of unread emails. Use when you need to know how many unread messages are in your inbox before sending new emails.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create AI Enrichment

Description

Tool to create an AI enrichment job for a campaign or lead list. Use when you need to enrich a resource with AI-driven insights.

Action Parameters

auto_update
input_columns
limit
model_version
stringRequired
output_column
stringRequired
overwrite
prompt
resource_id
stringRequired
resource_type
integerRequired
show_state
skip_leads_without_email
status
template_id
use_instantly_account

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create API Key

Description

Tool to create a new API key. Use when you need to generate credentials for programmatic access to the Instantly API.

Action Parameters

name
stringRequired
scopes
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Block List Entry

Description

Tool to create a new block list entry for a specific email or domain. Use when you need to prevent campaigns from sending emails to a specific address or domain.

Action Parameters

bl_value
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Campaign

Description

Tool to create a new campaign. Use when you have campaign details ready and want to launch.

Action Parameters

allow_risky_contacts
auto_variant_select
bcc_list
campaign_schedule
objectRequired
cc_list
daily_limit
daily_max_leads
disable_bounce_protect
email_gap
email_list
email_tag_list
first_email_text_only
insert_unsubscribe_header
is_evergreen
link_tracking
match_lead_esp
name
stringRequired
open_tracking
owned_by
pl_value
prioritize_new_leads
provider_routing_rules
random_wait_max
sequences
stop_for_company
stop_on_auto_reply
stop_on_reply
text_only

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Custom Tag

Description

Tool to create a new custom tag for organizing accounts and campaigns. Use when you need to create a new tag for categorization purposes.

Action Parameters

description
label
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Inbox Placement Test

Description

Tool to create an inbox placement test. Use when you need to measure deliverability across providers with your prepared email and recipient list.

Action Parameters

automations
campaign_id
delivery_mode
description
email_body
stringRequired
email_subject
stringRequired
emails
arrayRequired
name
stringRequired
not_sending_status
recipients_labels
run_immediately
schedule
sending_method
integerRequired
status
tags
test_code
text_only
timestamp_next_run
type
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Lead

Description

Tool to create a new lead. Use when you need to add an individual lead to a campaign.

Action Parameters

campaign
company_name
custom_variables
email
first_name
last_name
lt_interest_status
personalization
phone
website

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Lead List

Description

Tool to create a new lead list. Use when you need to organize leads into a dedicated list before importing them into campaigns.

Action Parameters

has_enrichment_task
name
stringRequired
owned_by

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Subsequence

Description

Tool to create a follow-up subsequence for a campaign. Use when you need to set up automated follow-up sequences triggered by lead conditions (CRM status, activities, reply keywords).

Action Parameters

conditions
objectRequired
name
stringRequired
parent_campaign
stringRequired
sequences
arrayRequired
subsequence_schedule
objectRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create SuperSearch Enrichment

Description

Tool to create a supersearch enrichment job for a list or campaign. Use when you need to enrich leads with data such as email verification, work email, profile information, job listings, technologies, news, or funding details.

Action Parameters

auto_update
enrichment_payload
input_columns
lead_ids
limit
model_version
overwrite_existing
resource_id
stringRequired
skip_leads_without_email
type
stringRequired
use_instantly_credits

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Webhook

Description

Tool to create a new webhook endpoint. Use when you need to receive Instantly event notifications via HTTP callbacks.

Action Parameters

campaign
custom_interest_value
event_type
target_hook_url
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete API Key

Description

Tool to delete an API key. Use when you need to remove a specific API key by its ID after confirming its existence.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Block List Entry

Description

Tool to delete a blocked email or domain entry by its ID. Use when you need to remove a specific block list entry.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Campaign

Description

Tool to delete a campaign. Use when you need to remove a specific campaign by ID.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Custom Tag

Description

Tool to delete a custom tag by its ID. Use when you need to remove a specific custom tag used for organizing and categorizing accounts and campaigns.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Lead

Description

Tool to delete a lead by its ID. Use when you need to remove a specific lead after confirming its existence.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Lead Label

Description

Tool to delete a lead label by ID. Use when you need to remove a custom label for categorizing and managing leads.

Action Parameters

id
stringRequired
reassigned_status

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Lead List

Description

Tool to delete a lead list by ID. Use when you need to remove a specific lead list after confirming its existence.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Subsequence

Description

Tool to delete a subsequence from a campaign. Use when you need to remove a specific subsequence by its UUID.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Webhook

Description

Tool to delete a webhook. Use when you need to remove a specific webhook by its UUID.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Whitelabel Domain

Description

Tool to delete the whitelabel domain from current workspace. Use when you need to remove the whitelabel domain configuration from a workspace.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Pre-warmed Up DFY Domains

Description

Tool to retrieve a list of pre-warmed up domains ready for DFY email account orders. Use when you need to check available domains that come pre-configured with SPF, DKIM, DMARC, and warmup already completed.

Action Parameters

domain_extensions
search

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Disable Account Warmup

Description

Tool to disable the warm-up process for email accounts. Use when you need to stop warmup for specific or all accounts before sending critical campaigns.

Action Parameters

emails
excluded_emails
include_all_emails

Action Response

created_at
stringRequired
data
objectRequired
entity_id
entity_type
error
id
stringRequired
progress
numberRequired
status
stringRequired
successful
booleanRequired
type
stringRequired
updated_at
stringRequired
user_id
workspace_id
stringRequired

Tool Name: Duplicate Campaign

Description

Tool to duplicate an existing campaign. Use when you need to create a copy of a campaign with the same configuration.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Duplicate Subsequence

Description

Tool to duplicate an existing subsequence to a specified parent campaign. Use when you need to create a copy of a subsequence with the same trigger conditions.

Action Parameters

id
stringRequired
name
stringRequired
parent_campaign
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Enable Account Warmup

Description

Tool to enable the warm-up process for email accounts. Use when you want to start warming up one or more accounts to improve deliverability.

Action Parameters

emails
excluded_emails
include_all_emails

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Export Campaign

Description

Tool to export campaign data to JSON format. Use when you need to retrieve complete campaign configuration for backup or migration.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Account Campaign Mappings

Description

Tool to retrieve campaigns associated with an email account. Use when you need to find which campaigns are mapped to a specific email address.

Action Parameters

email
stringRequired
limit
starting_after

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Daily Account Analytics

Description

Tool to retrieve daily account analytics showing emails sent per day for each account. Use when you need per-day performance metrics for email accounts.

Action Parameters

emails
end_date
start_date

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Accounts Warmup Analytics

Description

Tool to retrieve warmup analytics for specified email accounts. Use when you need daily and aggregate warmup statistics including health scores.

Action Parameters

emails
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Audit Logs

Description

Tool to retrieve audit log records for tracking system activities. Use when you need to review account activity history or monitor changes.

Action Parameters

limit
starting_after

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Block List Entry

Description

Tool to retrieve a specific blocked email or domain entry by its ID. Use when you have a block list entry UUID and need to check block details.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Campaign

Description

Tool to retrieve campaign details. Use when you need full campaign configuration for a given campaign ID.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Campaign Analytics

Description

Tool to retrieve analytics for campaigns. Use when you need performance metrics for one or multiple campaigns.

Action Parameters

end_date
exclude_total_leads_count
id
ids
start_date

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Campaign Sending Status

Description

Tool to retrieve campaign sending status diagnostics explaining why a campaign may not be sending emails or is sending slower than expected. Use when troubleshooting campaign delivery issues or understanding campaign health.

Action Parameters

id
stringRequired
with_ai_summary

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Campaign Steps Analytics

Description

Tool to retrieve analytics data broken down by campaign steps and variants. Use when you need detailed performance metrics for each step in a campaign sequence.

Action Parameters

campaign_id
end_date
stringRequired
include_opportunities_count
start_date
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Current Workspace

Description

Tool to retrieve current workspace details based on API key. Use when you need workspace information like plan details, owner, or organization settings.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Custom Tag

Description

Tool to retrieve a specific custom tag by ID. Use when you need details about a custom tag used for organizing accounts and campaigns.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Custom Tag Mappings

Description

Tool to retrieve custom tag mappings that connect tags to resources like campaigns and email accounts. Use when you need to see which tags are assigned to which resources.

Action Parameters

limit
resource_ids
starting_after
tag_ids

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Daily Campaign Analytics

Description

Tool to retrieve daily analytics for a campaign. Use when you need per-day performance metrics for campaigns.

Action Parameters

campaign_id
campaign_status
end_date
start_date

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get DFY Email Account Order Accounts

Description

Tool to retrieve DFY (Done-For-You) email account order accounts. Use when you need to fetch accounts from DFY email account orders with optional pagination and password inclusion.

Action Parameters

limit
starting_after
with_passwords

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Email Service Provider Options

Description

Tool to retrieve email service provider options for inbox placement tests. Use when you need valid recipients_labels options.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Inbox Placement Analytics Stats By Date

Description

Tool to retrieve time-series statistics for inbox placement test results by date. Use when you need daily analytics showing how emails were distributed across inbox, spam, and category folders.

Action Parameters

test_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Inbox Placement Test

Description

Tool to retrieve inbox placement test results. Use when you need details for a specific inbox placement test by ID.

Action Parameters

id
stringRequired
with_metadata

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Lead

Description

Tool to retrieve details of a specific lead by its ID. Use when you have the lead UUID and need full lead metadata.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Lead Label

Description

Tool to retrieve a specific lead label by ID. Use when you need details about a custom label for categorizing and managing leads.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Lead Label by ID

Description

Tool to retrieve a specific lead label by ID. Use when you need details about a custom label for categorizing and managing leads.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Lead List

Description

Tool to retrieve details of a specific lead list by its ID. Use when you have the lead list UUID and need list metadata.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get CRM Phone Numbers

Description

Tool to retrieve all phone numbers associated with your organization. Use when you need to list phone numbers configured for CRM actions.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Similar DFY Email Account Order Domains

Description

Tool to generate similar available domain suggestions for DFY email account orders. Use when you need to find available domain alternatives based on a provided domain. Returns maximum of 66 suggestions per extension (TLD) requested.

Action Parameters

domain
stringRequired
extensions

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Subsequence

Description

Tool to retrieve a specific subsequence by its ID. Use when you need full details of a follow-up sequence entity.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get SuperSearch Enrichment

Description

Tool to retrieve enrichment data for a supersearch lead by resource ID. Use when you need detailed enrichment information for a lead obtained from a supersearch operation.

Action Parameters

resource_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Lead List Verification Stats

Description

Tool to retrieve verification statistics for a lead list. Use when you need summary counts by verification status for a specific lead list.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Webhook

Description

Tool to retrieve details of a specific webhook subscription. Use when you have the webhook ID and need full webhook configuration.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Webhook Event

Description

Tool to retrieve details of a specific webhook event. Use when you need to inspect a particular webhook event by its ID.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Webhook Events Summary

Description

Tool to retrieve webhook events summary with success and failure statistics. Use when you need aggregated webhook delivery metrics for a date range.

Action Parameters

from_date
stringRequired
to_date
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Webhook Events Summary By Date

Description

Tool to retrieve webhook event summaries grouped by date. Use when you need aggregated webhook event statistics over a date range.

Action Parameters

from_date
stringRequired
to_date
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Webhook Event Types

Description

Tool to retrieve all available webhook event types. Use when you need to see valid event types for webhook subscriptions.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Workspace Billing Plan Details

Description

Tool to retrieve workspace billing plan details. Use when you need to view billing plan information for various services like lead finder, verification, CRM, website visitor tracking, and inbox placement.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Workspace Member

Description

Tool to retrieve details of a specific workspace member by ID. Use when you need member details including user information, role, and permissions.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Inbox Placement Deliverability Insights

Description

Tool to retrieve deliverability insights for inbox placement tests. Use when you need detailed percentage breakdowns of emails landing in spam, inbox, and category folders with optional date range filtering and previous period comparison.

Action Parameters

date_from
date_to
previous_date_from
previous_date_to
recipient_esp
recipient_geo
recipient_type
show_previous
test_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Inbox Placement Analytics Stats By Test ID

Description

Tool to retrieve aggregated inbox placement analytics statistics for specified test IDs. Use when you need consolidated inbox, spam, and category counts across multiple tests with optional filtering by date range, recipient geo, type, ESP, or sender email.

Action Parameters

date_from
date_to
recipient_esp
recipient_geo
recipient_type
sender_email
test_ids
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Lead Label

Description

Tool to create a custom lead label for categorizing leads. Use when you need to create a new label to organize and manage leads with specific interest status categories.

Action Parameters

description
interest_status_label
stringRequired
label
stringRequired
use_with_ai

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Email Accounts

Description

Tool to list all email accounts for the authenticated user. Use after obtaining auth credentials to retrieve available accounts.

Action Parameters

limit
provider_code
search
starting_after
status
tag_ids

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List API Keys

Description

Tool to list all API keys. Use when you need to retrieve your API keys with optional pagination after authentication.

Action Parameters

limit
starting_after

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Block List Entries

Description

Tool to list blocked emails or domains from blocklist. Use when you need to retrieve multiple block list entries with optional filtering by domains only or search terms. Supports pagination.

Action Parameters

domains_only
limit
search
starting_after

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Campaigns

Description

Tool to list all campaigns. Use when you need to fetch your campaigns list with optional filters and pagination.

Action Parameters

limit
search
starting_after
tag_ids

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Custom Tags

Description

Tool to list custom tags. Use when you need to retrieve custom tags with optional pagination and filtering.

Action Parameters

limit
resource_ids
search
starting_after
tag_ids

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List DFY Email Account Orders

Description

Tool to list DFY email account orders. Use when you need to fetch your DFY email account orders with pagination.

Action Parameters

limit
starting_after

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Emails

Description

Tool to list emails. Use when you need to retrieve emails with optional filters and pagination.

Action Parameters

assigned_to
campaign_id
company_domain
eaccount
email_type
has_reminder
i_status
is_unread
lead
limit
marked_as_done
mode
preview_only
scheduled_only
search
sort_order
starting_after

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Inbox Placement Blacklist & SpamAssassin Reports

Description

Tool to list inbox placement blacklist & SpamAssassin reports. Use when you need to retrieve spam and blacklist analytics after running an inbox placement test.

Action Parameters

date_from
date_to
limit
skip_blacklist_report
skip_spam_assassin_report
starting_after
test_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Inbox Placement Tests

Description

Tool to list inbox placement tests. Use when you need a paginated overview of tests with optional filtering and sort order.

Action Parameters

limit
search
sort_order
starting_after
status

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Lead Lists

Description

Tool to list all lead lists. Use when you need to fetch the lead lists with optional filters and pagination.

Action Parameters

has_enrichment_task
limit
search
starting_after

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Leads

Description

Tool to list leads. Use when you need to retrieve leads with optional filters like search, status filters, and pagination.

Action Parameters

campaign
contacts
excluded_ids
filter
ids
in_campaign
in_list
limit
list_id
queries
search
starting_after

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Email Threads

Description

Tool to list email threads. Use when fetching threads with optional pagination and unread-only filtering. Note: Instantly's public API does not expose a dedicated GET /emails/threads endpoint. Threads can be derived by grouping emails (GET /emails) by their `thread_id`. This action implements that logic by querying /emails and aggregating into threads.

Action Parameters

is_unread
limit
starting_after

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Webhook Events

Description

Tool to list webhook events. Use when you need to view received webhook events with optional pagination and filters.

Action Parameters

from_date
limit
search
starting_after
success
to_date

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Webhooks

Description

Tool to list configured webhooks. Use when you need to retrieve your webhook configurations with optional filters and pagination.

Action Parameters

campaign
event_type
limit
starting_after

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Mark Thread As Read

Description

Tool to mark all emails in a specific thread as read. Use when you want to update the read status of an email thread after processing.

Action Parameters

thread_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Merge Leads

Description

Tool to merge multiple leads into a single lead. Use after confirming both source and destination lead IDs exist.

Action Parameters

destination_lead_id
stringRequired
lead_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Move Leads

Description

Tool to move leads from one campaign to another. Use when you need to transfer specific leads between campaigns.

Action Parameters

campaign
stringRequired
ids
arrayRequired
to_campaign_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Lead Label

Description

Tool to update an existing lead label by ID. Use when you need to modify a custom label for categorizing and managing leads.

Action Parameters

description
id
stringRequired
interest_status_label
label
use_with_ai

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Patch SuperSearch Enrichment Settings

Description

Tool to update auto-update and skip settings for SuperSearch enrichment. Use when you need to configure enrichment behavior for leads in a list or campaign, including automatic enrichment of new leads, skipping leads without emails, evergreen updates, and overwrite settings.

Action Parameters

auto_update
is_evergreen
overwrite
resource_id
stringRequired
skip_rows_without_email

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Patch Webhook

Description

Tool to update an existing webhook configuration. Use when you need to modify webhook properties like name, event type, or target URL.

Action Parameters

campaign
custom_interest_value
event_type
headers
id
stringRequired
name
target_hook_url

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Pause Campaign

Description

Tool to pause an active campaign. Use when you need to suspend sending operations for a specific campaign.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Pause Subsequence

Description

Tool to pause an active campaign subsequence. Use when you need to temporarily suspend a follow-up sequence.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Remove Lead From Subsequence

Description

Tool to remove a lead from a campaign subsequence. Use when you need to stop a lead from receiving subsequence emails.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Resume Subsequence

Description

Tool to resume a paused campaign subsequence. Use when you need to restart a previously paused follow-up sequence.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Search Campaigns by Lead Email

Description

Tool to search campaigns by a lead's email address. Use when you need to find campaigns containing a specific lead by their email.

Action Parameters

search
stringRequired
sort_column
sort_order

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Set Whitelabel Domain

Description

Tool to set whitelabel agency domain for current workspace. Use when you need to configure custom branding with your own domain name for the workspace.

Action Parameters

domain
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Share Campaign

Description

Tool to share a campaign. Use when you need to share a campaign template for 7 days.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Run SuperSearch Enrichment

Description

Tool to run all enrichments for resource leads or unenriched leads. Use when you need to trigger enrichment processes for a list or campaign.

Action Parameters

resource_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Test Accounts Vitals

Description

Tool to test IMAP/SMTP connectivity and account vitals for email accounts. Use when you need to verify email account health and connectivity status.

Action Parameters

accounts
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Test Webhook

Description

Tool to send a test payload to verify a webhook is working. Use when you need to verify a webhook configuration.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Toggle Resource

Description

Tool to assign or unassign custom tags to resources like accounts and campaigns. Use when you need to manage custom tag associations with resources by either assigning or unassigning tags.

Action Parameters

assign
booleanRequired
filter
resource_ids
arrayRequired
resource_type
integerRequired
selected_all
tag_ids
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Block List Entry

Description

Tool to update a blocked email or domain entry. Use when you need to modify the bl_value of an existing block list entry.

Action Parameters

bl_value
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Campaign

Description

Tool to update details of a campaign. Use when you need to modify campaign settings after verifying its ID.

Action Parameters

allow_risky_contacts
auto_variant_select
bcc_list
campaign_schedule
cc_list
daily_limit
daily_max_leads
disable_bounce_protect
email_gap
email_list
email_tag_list
first_email_text_only
id
stringRequired
insert_unsubscribe_header
is_evergreen
link_tracking
match_lead_esp
name
open_tracking
owned_by
pl_value
prioritize_new_leads
provider_routing_rules
random_wait_max
sequences
stop_for_company
stop_on_auto_reply
stop_on_reply
text_only

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Custom Tag

Description

Tool to update an existing custom tag's label or description. Use when you need to modify a custom tag used for organizing accounts and campaigns.

Action Parameters

description
id
stringRequired
label

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Inbox Placement Test

Description

Tool to update an inbox placement test. Use when you need to modify an existing inbox placement test by its ID.

Action Parameters

automations
campaign_id
delivery_mode
description
email_body
email_subject
emails
id
stringRequired
name
not_sending_status
recipients_labels
schedule
sending_method
status
tags
test_code
text_only
timestamp_next_run
type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Lead

Description

Tool to update a lead's details. Use when you need to modify fields of an existing lead after identifying its ID.

Action Parameters

company_name
first_name
id
stringRequired
last_name
lt_interest_status
personalization
phone
website

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Lead Interest Status

Description

Tool to update a lead's interest status. Use when you need to set or reset a lead’s interest status for follow-up actions.

Action Parameters

ai_interest_value
campaign_id
disable_auto_interest
interest_value
Required
lead_email
stringRequired
list_id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Lead List

Description

Tool to update details of a specific lead list by its ID. Use after verifying the list ID exists.

Action Parameters

has_enrichment_task
id
stringRequired
name
owned_by

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Subsequence

Description

Tool to update a campaign subsequence entity. Use when you need to modify subsequence settings such as name, schedule, or triggered CRM statuses.

Action Parameters

crm_statuses
id
stringRequired
name
parent_campaign
sequences
subsequence_schedule

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Current Workspace

Description

Tool to update the current workspace details. Use when you need to modify workspace settings such as name or logo URL.

Action Parameters

name
org_logo_url

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Verify Email

Description

Tool to initiate email verification. Use when you need to verify an email's deliverability before sending emails.

Action Parameters

email
stringRequired
webhook_url

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Admin Workspace Group Member

Description

Tool to retrieve admin workspace details for the current sub workspace. Use when you need to get information about the admin workspace relationship, including workspace IDs and status.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Workspace Member by ID

Description

Tool to retrieve details of a specific workspace member by ID. Use when you need information about a member of a workspace with associated user details.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add Workspace Member

Description

Tool to add a new member to workspace with email and role. Use when you need to invite a new team member to the workspace with specific role and permissions.

Action Parameters

email
stringRequired
permissions
role
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired