Instantly

instantly

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

Drip Emails Marketing Automation Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (47)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Check Email Verification StatusINSTANTLY_CHECK_EMAIL_VERIFICATION_STATUSAcción

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.

Parámetros de entrada

emailstringObligatorioemail
Email address to check verification status

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Count Unread EmailsINSTANTLY_COUNT_UNREAD_EMAILSAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create AI EnrichmentINSTANTLY_CREATE_AI_ENRICHMENTAcción

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.

Parámetros de entrada

limitinteger
Maximum number of leads to enrich (1–1,000,000)
promptstring
Custom prompt to use (when template_id is not provided)
statusinteger
Filter by job status: 1=pending, 2=processing, 3=completed, 4=failed
overwriteboolean
Whether to overwrite existing values in the output column
show_stateboolean
Return the current state of the enrichment job in the response
auto_updateboolean
Automatically enrich new leads added after job creation
resource_idstringObligatorio
UUID of the resource (campaign or list) to enrich
template_idinteger
ID of a pre-defined prompt template to use
input_columnsstring[]
List of input column names to feed into the model
model_versionstringObligatorio
Model version to use. Allowed values: 3.5, 4.0, gpt-4o, gpt-5, gpt-5-mini, gpt-5-nano, o3, gpt-4.1, claude-3.7-sonnet, claude-3.5-sonnet
output_columnstringObligatorio
Column name to store the AI enrichment result
resource_typeintegerObligatorio
Type of resource: 1 = Campaign, 2 = List
use_instantly_accountboolean
Whether to use Instantly's own account for API calls
skip_leads_without_emailboolean
Skip leads that do not have an email address

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create API KeyINSTANTLY_CREATE_API_KEYAcción

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

Parámetros de entrada

namestringObligatorio
Human-readable name for the new API key
scopesstring[]Obligatorio
List of permission scopes for the key; e.g., 'campaigns:create', 'campaigns:read'.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create CampaignINSTANTLY_CREATE_CAMPAIGNAcción

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

Parámetros de entrada

namestringObligatorio
Name of the campaign
cc_liststring[]
CC list
bcc_liststring[]
BCC list
owned_bystring
Owner ID
pl_valuenumber
Value of every positive lead
email_gapnumber
Gap between emails in minutes
sequencesobject[]
Email sequences; only first element is used; add steps inside it
text_onlyboolean
Send as text-only
email_liststring[]
Accounts to use for sending
daily_limitinteger
Daily sending limit
is_evergreenboolean
Whether the campaign is evergreen
link_trackingboolean
Track link clicks
open_trackingboolean
Track opens
stop_on_replyboolean
Stop campaign on reply
email_tag_liststring[]
Tag IDs to use for sending
match_lead_espboolean
Match lead by ESP
daily_max_leadsinteger
Max new leads to contact daily
random_wait_maxnumber
Max random wait in minutes
stop_for_companyboolean
Stop for company on reply
campaign_scheduleobjectObligatorio
Schedule configuration for the campaign
stop_on_auto_replyboolean
Stop on auto-reply
auto_variant_selectobject
Auto variant select settings
allow_risky_contactsboolean
Allow risky contacts
prioritize_new_leadsboolean
Prioritize new leads
first_email_text_onlyboolean
First email as text-only
disable_bounce_protectboolean
Disable bounce protect
provider_routing_rulesobject[]
Provider routing rules
insert_unsubscribe_headerboolean
Insert unsubscribe header

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Inbox Placement TestINSTANTLY_CREATE_INBOX_PLACEMENT_TESTAcción

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

Parámetros de entrada

namestringObligatorio
Name of the inbox placement test
tagsstring[]
List of tag UUIDs to apply to the test
typeintegerObligatorioenum
Test type: 1=one-time, 2=automated
12
emailsstring[]Obligatorio
List of recipient email addresses for the test
statusintegerenum
Initial status: 1=Active, 2=Paused, 3=Completed
123
scheduleobject
Schedule settings for automated inbox placement tests.
test_codestring
External identifier for tests sent from outside Instantly
text_onlyboolean
If true, send plain-text only and disable open tracking
email_bodystringObligatorio
HTML body of the test email
automationsobject[]
Automations to trigger based on test results or schedule
campaign_idstring
UUID of the campaign to associate with the test
descriptionstring
Optional description of the test
delivery_modeintegerenum
Delivery mode: 1=one by one, 2=all together
12
email_subjectstringObligatorio
Subject line for the test email
sending_methodintegerObligatorioenum
Sending method: 1=From Instantly, 2=From outside Instantly
12
run_immediatelyboolean
If true, trigger the test immediately in addition to schedule
recipients_labelsobject[]
Label settings for email service providers; fetch options via GET /inbox-placement-tests/email-service-provider-options
not_sending_statusstringenum
Reason for not sending: 'daily_limits_hit' or 'other'
daily_limits_hitother
timestamp_next_runstring
Next run timestamp in ISO 8601 format

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create LeadINSTANTLY_CREATE_LEADAcción

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

Parámetros de entrada

emailstring
Email address of the lead
phonestring
Phone number of the lead
websitestring
Website URL of the lead
campaignstring
UUID of the campaign to associate the lead with
last_namestring
Last name of the lead
first_namestring
First name of the lead
company_namestring
Company name of the lead
personalizationstring
Personalized note or message for the lead
lt_interest_statusintegerenum
Lead interest status; allowed values: 0=Out of Office, 1=Interested, 2=Meeting Booked, 3=Meeting Completed, 4=Closed, -1=Not Interested, -2=Wrong Person, -3=Lost
-3-2-101234

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Lead ListINSTANTLY_CREATE_LEAD_LISTAcción

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

Parámetros de entrada

namestringObligatorio
Name of the lead list
owned_bystring
Owner user ID (UUID); defaults to creator if not provided
has_enrichment_taskboolean
Whether to run enrichment on added leads

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create WebhookINSTANTLY_CREATE_WEBHOOKAcción

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

Parámetros de entrada

campaignstring
Filter webhook events to a specific campaign by its UUID; null for all campaigns
event_typestring
Event that triggers the webhook; use 'all_events' to subscribe to all events. See GET /webhooks/event-types for valid values
target_hook_urlstringObligatorio
Target URL to send webhook payloads; must start with http:// or https://
custom_interest_valueinteger
Custom interest value for custom label events; corresponds to LeadLabel.interest_status

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete API KeyINSTANTLY_DELETE_API_KEYAcción

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

Parámetros de entrada

idstringObligatorio
UUID of the API key to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete CampaignINSTANTLY_DELETE_CAMPAIGNAcción

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

Parámetros de entrada

idstringObligatorio
UUID of the campaign to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete LeadINSTANTLY_DELETE_LEADAcción

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

Parámetros de entrada

idstringObligatorio
UUID of the lead to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Lead ListINSTANTLY_DELETE_LEAD_LISTAcción

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

Parámetros de entrada

idstringObligatorio
UUID of the lead list to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete WebhookINSTANTLY_DELETE_WEBHOOKAcción

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

Parámetros de entrada

idstringObligatorio
UUID of the webhook to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Disable Account WarmupINSTANTLY_DISABLE_ACCOUNT_WARMUPAcción

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.

Parámetros de entrada

emailsstring[]
List of emails to disable warmup for (max 100).
excluded_emailsstring[]
List of emails to exclude when `include_all_emails` is true (max 100).
include_all_emailsboolean
If true, disable warmup on all accounts.

Parámetros de salida

idstringObligatorio
Unique identifier for the background job.
dataobjectObligatorio
Additional job data.
typestringObligatorio
Background job type; includes 'update-warmup-accounts'.
errorstring
Error if any occurred during the execution of the action
statusstringObligatorioenum
Job status.
pendingin-progresssuccessfailed
user_idstring
ID of the user who triggered the job.
progressintegerObligatorio
Job progress percentage (0-100).
entity_idstring
ID of the related entity for the job.
created_atstringObligatorio
Timestamp when the job was created (ISO 8601 date-time).
successfulbooleanObligatorio
Whether or not the action execution was successful or not
updated_atstringObligatorio
Timestamp when the job was last updated (ISO 8601 date-time).
entity_typestringObligatorioenum
Entity type associated with the job.
listcampaignworkspace
workspace_idstringObligatorio
Workspace ID.

Enable Account WarmupINSTANTLY_ENABLE_ACCOUNT_WARMUPAcción

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.

Parámetros de entrada

emailsstring[]
List of email addresses to enable warmup for; max 100 items
excluded_emailsstring[]
List of email addresses to exclude when include_all_emails is true; max 100 items
include_all_emailsboolean
If true, enable warmup for all email accounts in the workspace

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get CampaignINSTANTLY_GET_CAMPAIGNAcción

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

Parámetros de entrada

idstringObligatoriouuid
UUID of the campaign to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Campaign AnalyticsINSTANTLY_GET_CAMPAIGN_ANALYTICSAcción

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

Parámetros de entrada

idstring
Campaign UUID to retrieve analytics for a single campaign
idsstring[]
List of campaign UUIDs to retrieve analytics for multiple campaigns
end_datestring
End date filter (YYYY-MM-DD)
start_datestring
Start date filter (YYYY-MM-DD)
exclude_total_leads_countboolean
If true, exclude total leads count to speed response

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Daily Campaign AnalyticsINSTANTLY_GET_DAILY_CAMPAIGN_ANALYTICSAcción

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

Parámetros de entrada

end_datestring
End date (inclusive) for analytics in YYYY-MM-DD format
start_datestring
Start date (inclusive) for analytics in YYYY-MM-DD format
campaign_idstring
Campaign ID (UUID); omit to retrieve analytics for all campaigns
campaign_statusinteger
Filter by campaign status. Allowed values: 0=Draft, 1=Active, 2=Paused, 3=Completed, 4=Running Subsequences, -99=Account Suspended, -1=Accounts Unhealthy, -2=Bounce Protect

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Email Service Provider OptionsINSTANTLY_GET_EMAIL_SERVICE_PROVIDER_OPTIONSAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Inbox Placement TestINSTANTLY_GET_INBOX_PLACEMENT_TESTAcción

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

Parámetros de entrada

idstringObligatorio
UUID of the inbox placement test
with_metadataboolean
Whether to include campaign and tags metadata in response

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get LeadINSTANTLY_GET_LEADAcción

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

Parámetros de entrada

idstringObligatorio
UUID of the lead

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Lead ListINSTANTLY_GET_LEAD_LISTAcción

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

Parámetros de entrada

idstringObligatorio
UUID of the lead list

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Lead List Verification StatsINSTANTLY_GET_VERIFICATION_STATS_FOR_LEAD_LISTAcción

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

Parámetros de entrada

idstringObligatorio
UUID of the lead list

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get WebhookINSTANTLY_GET_WEBHOOKAcción

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

Parámetros de entrada

idstringObligatorio
UUID of the webhook

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Webhook EventINSTANTLY_GET_WEBHOOK_EVENTAcción

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

Parámetros de entrada

idstringObligatoriouuid
UUID of the webhook event to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Email AccountsINSTANTLY_LIST_ACCOUNTSAcción

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

Parámetros de entrada

limitinteger
Maximum number of items to return, between 1 and 100
searchstring
Search string to filter accounts, e.g., domain or email substring
statusinteger
Filter by account status: 1 Active; 2 Paused; -1 Connection Error; -2 Soft Bounce Error; -3 Sending Error
tag_idsstring
Comma-separated list of tag UUIDs to filter accounts
provider_codeinteger
Filter by email provider: 1 Custom IMAP/SMTP; 2 Google; 3 Microsoft; 4 AWS
starting_afterstring
Cursor for pagination. Use 'next_starting_after' from previous response

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List API KeysINSTANTLY_LIST_API_KEYSAcción

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

Parámetros de entrada

limitinteger
Number of API keys to return, between 1 and 100
starting_afterstring
ID of the last API key from previous page for pagination

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List CampaignsINSTANTLY_LIST_CAMPAIGNSAcción

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

Parámetros de entrada

limitinteger
Number of campaigns to return, between 1 and 100
searchstring
Search text to filter campaign names
tag_idsstring
Comma-separated tag UUIDs to filter campaigns
starting_afterstring
UUID cursor to start listing after for pagination

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Custom TagsINSTANTLY_LIST_CUSTOM_TAGSAcción

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

Parámetros de entrada

limitinteger
Number of custom tags to return, between 1 and 100
searchstring
Search text to filter custom tags by label or description
tag_idsstring
Comma-separated tag IDs to filter by
resource_idsstring
Comma-separated resource IDs (account or campaign) to filter by
starting_afterstring
Cursor ID to start listing after for pagination

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List DFY Email Account OrdersINSTANTLY_LIST_DFY_EMAIL_ACCOUNT_ORDERSAcción

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

Parámetros de entrada

limitinteger
Number of DFY Email Account Orders to return, between 1 and 100
starting_afterstring
ID of the last order from the previous page for pagination

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List EmailsINSTANTLY_LIST_EMAILSAcción

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

Parámetros de entrada

leadstring
Filter by lead email address
modestringenum
Unibox mode filter: emode_focused, emode_others, or emode_all
emode_focusedemode_othersemode_all
limitinteger
Number of items to return, between 1 and 100
searchstring
Search by lead email or 'thread:<thread_id>' to filter by thread
eaccountstring
Email account used to send the email
i_statusinteger
Email status to filter by
is_unreadboolean
Filter only unread emails
email_typestringenum
Filter by email type: received, sent, or manual
receivedsentmanual
sort_orderstringenum
Sort order: asc or desc
ascdesc
assigned_tostring
Filter by assignee user ID
campaign_idstring
Campaign ID (UUID) to filter emails
has_reminderboolean
Filter emails that have a reminder set
preview_onlyboolean
Filter preview-only emails
company_domainstring
Filter by lead company domain
marked_as_doneboolean
Filter emails marked as done
scheduled_onlyboolean
Return only scheduled emails
starting_afterstring
Cursor ID to start listing from for pagination

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Inbox Placement Blacklist & SpamAssassin ReportsINSTANTLY_LIST_INBOX_PLACEMENT_BLACKLIST_AND_SPAM_ASSASSIN_REPORTSAcción

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

Parámetros de entrada

limitinteger
Number of items to return, between 1 and 100
date_tostring
Filter items created at or before this timestamp (ISO 8601)
test_idstringObligatorio
Inbox Placement Test ID to filter by
date_fromstring
Filter items created at or after this timestamp (ISO 8601)
starting_afterstring
Cursor of last item from previous page for pagination
skip_blacklist_reportboolean
If true, omit blacklist_report from each item
skip_spam_assassin_reportboolean
If true, omit spam_assassin_report from each item

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Inbox Placement TestsINSTANTLY_LIST_INBOX_PLACEMENT_TESTSAcción

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

Parámetros de entrada

limitinteger
Number of tests to return, between 1 and 100
searchstring
Search term to filter tests by name or content
statusintegerenum
Filter by status: 1=Active, 2=Paused, 3=Completed
123
sort_orderstringenum
Sort order by id (UUIDv7 timestamp); asc or desc
ascdesc
starting_afterstring
UUID cursor to start listing after for pagination

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Lead ListsINSTANTLY_LIST_LEAD_LISTSAcción

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

Parámetros de entrada

limitinteger
Number of lead lists to return, between 1 and 100
searchstring
Search text to filter lead list names
starting_afterstring
Cursor timestamp (ISO 8601) to start listing after for pagination
has_enrichment_taskboolean
Filter lists that have an enrichment task

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List LeadsINSTANTLY_LIST_LEADSAcción

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

Parámetros de entrada

idsstring[]
Only include these lead IDs (UUID strings)
limitinteger
Page size limit between 1 and 100
filterstring
Lead filter status; allowed values: FILTER_VAL_CONTACTED, FILTER_VAL_NOT_CONTACTED, FILTER_VAL_COMPLETED, FILTER_VAL_UNSUBSCRIBED, FILTER_VAL_ACTIVE, FILTER_LEAD_INTERESTED, FILTER_LEAD_NOT_INTERESTED, FILTER_LEAD_MEETING_BOOKED
searchstring
Search by first name, last name, or email
in_listboolean
Whether the lead is in any list
list_idstring
Lead list ID to filter leads
queriesobject[]
Advanced query conditions as raw JSON objects
campaignstring
Campaign ID to filter leads
contactsstring[]
Only include leads with these emails
in_campaignboolean
Whether the lead is in any campaign
excluded_idsstring[]
Exclude these lead IDs (UUID strings)
starting_afterstring
Cursor of last item from previous page for pagination

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Email ThreadsINSTANTLY_LIST_THREADSAcción

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.

Parámetros de entrada

limitinteger
Number of threads to return, between 1 and 100
is_unreadboolean
If true, only include unread threads
starting_afterstring
Cursor of the last thread from previous page for pagination

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Webhook EventsINSTANTLY_LIST_WEBHOOK_EVENTSAcción

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

Parámetros de entrada

limitinteger
Number of items to return, between 1 and 100
searchstring
Exact match on webhook URL or lead email
successboolean
Filter events by success status
to_datestring
Inclusive end date filter in YYYY-MM-DD format
from_datestring
Inclusive start date filter in YYYY-MM-DD format
starting_afterstring
Cursor for pagination. ID of the last item from the previous page

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List WebhooksINSTANTLY_LIST_WEBHOOKSAcción

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

Parámetros de entrada

limitinteger
Number of webhooks to return, between 1 and 100
campaignstring
Filter webhooks by campaign UUID
event_typestring
Filter webhooks by event type. Allowed: all_events, email_sent, email_opened, email_link_clicked, reply_received, email_bounced, lead_unsubscribed, campaign_completed, account_error, lead_neutral, etc.
starting_afterstring
Cursor (webhook ID) to start listing after for pagination

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Mark Thread As ReadINSTANTLY_MARK_THREAD_AS_READAcción

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.

Parámetros de entrada

thread_idstringObligatorio
UUID of the email thread to mark as read

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Merge LeadsINSTANTLY_MERGE_LEADSAcción

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

Parámetros de entrada

lead_idstringObligatorio
UUID of the source lead to be merged
destination_lead_idstringObligatorio
UUID of the destination lead that will receive merged data

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search Campaigns by Lead EmailINSTANTLY_SEARCH_CAMPAIGNS_BY_LEAD_EMAILAcción

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

Parámetros de entrada

searchstringObligatorio
Lead email to search
sort_orderstringenum
Sort direction, either 'asc' or 'desc' (default 'asc')
ascdesc
sort_columnstring
Column to sort by, default 'timestamp_created'

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update CampaignINSTANTLY_UPDATE_CAMPAIGNAcción

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

Parámetros de entrada

idstringObligatorio
UUID of the campaign to update
namestring
New campaign name
cc_liststring[]
List of email addresses to CC
bcc_liststring[]
List of email addresses to BCC
owned_bystring
UUID of the new owner; null to unset
pl_valuenumber
Value for each positive lead; null to unset
email_gapinteger
Gap between emails in minutes; null to unset
sequencesobject[]
List of sequence objects; only first is honored; include steps inside
text_onlyboolean
Send emails as text-only; null to unset
email_liststring[]
List of sender account UUIDs to use
daily_limitinteger
Daily send limit; null for unlimited
is_evergreenboolean
Whether the campaign is evergreen; null to unset
link_trackingboolean
Enable link click tracking; null to unset
open_trackingboolean
Enable open tracking; null to unset
stop_on_replyboolean
Stop campaign when a lead replies; null to unset
email_tag_liststring[]
List of email tag UUIDs to apply
match_lead_espboolean
Match leads by ESP; null to unset
daily_max_leadsinteger
Max new leads to contact per day; null to unset
random_wait_maxinteger
Maximum random wait in minutes; null to unset
stop_for_companyboolean
Stop for company on reply; null to unset
campaign_scheduleobject
Raw campaign schedule configuration
stop_on_auto_replyboolean
Stop on auto-reply; null to unset
auto_variant_selectobject
Settings for auto variant selection
allow_risky_contactsboolean
Allow sending to risky contacts; null to unset
prioritize_new_leadsboolean
Prioritize new leads; null to unset
first_email_text_onlyboolean
Send only the first email as text-only; null to unset
disable_bounce_protectboolean
Disable bounce protection; null to unset
provider_routing_rulesobject[]
Custom provider routing rule objects
insert_unsubscribe_headerboolean
Insert unsubscribe header; null to unset

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update LeadINSTANTLY_UPDATE_LEADAcción

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

Parámetros de entrada

idstringObligatorio
UUID of the lead to update.
phonestring
Phone number of the lead, or null to clear.
websitestring
Website URL of the lead, or null to clear.
last_namestring
Last name of the lead, or null to clear.
first_namestring
First name of the lead, or null to clear.
company_namestring
Company name of the lead, or null to clear.
personalizationstring
Personalization content for the lead, or null to clear.
lt_interest_statusinteger
Lead interest status. Static values: 0=Out of Office, 1=Interested, 2=Meeting Booked, 3=Meeting Completed, 4=Closed, -1=Not Interested, -2=Wrong Person, -3=Lost; or custom status.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Lead Interest StatusINSTANTLY_UPDATE_LEAD_INTEREST_STATUSAcción

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.

Parámetros de entrada

list_idstring
Optional list ID to scope the update
lead_emailstringObligatorio
Email address of the lead whose interest status to update
campaign_idstring
Optional campaign ID to scope the update
interest_valueintegerObligatorioenum
Interest status code. Set to null to reset to 'Lead'. Valid values: 0=Out of Office, 1=Interested, 2=Meeting Booked, 3=Meeting Completed, 4=Closed, -1=Not Interested, -2=Wrong Person, -3=Lost
-3-2-101234
ai_interest_valueinteger
Optional AI interest value for the lead
disable_auto_interestboolean
Disable Instantly's automatic interest updates when set to true

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Lead ListINSTANTLY_UPDATE_LEAD_LISTAcción

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

Parámetros de entrada

idstringObligatorio
UUID of the lead list to update
namestring
New name for the lead list
owned_bystring
User ID of the new owner (UUID)
has_enrichment_taskboolean
Whether this list runs the enrichment process on every added lead

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Verify EmailINSTANTLY_VERIFY_EMAILAcción

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

Parámetros de entrada

emailstringObligatorio
Email address to verify in RFC 5322 format.
webhook_urlstring
Optional webhook URL to receive verification results asynchronously if the process takes longer than 10 seconds.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not