Skip to main content
Instantly logo
  • Category: drip emails
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 122
  • Triggers: 0
  • Slug: INSTANTLY
  • Version: 20261101_00

Frequently Asked Questions

For a step-by-step guide on creating and configuring your own Instantly OAuth credentials with Composio, see How to create OAuth credentials for Instantly.

Tools

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

Input Parameters

string
required
The domain/host to check CTD status for. Verifies SSL configuration and CNAME records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_ACTIVATE_CAMPAIGNTool 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.

Input Parameters

string
required
UUID of the campaign to activate

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_ADD_LEADS_BULKTool 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.

Input Parameters

array
required
List of leads to add. Each lead must have at least an email address.
boolean
Verify leads on import
string
UUID of the list to add leads to. Either campaign_id or list_id is required.
string
UUID of the campaign to add leads to. Either campaign_id or list_id is required.
string
Blocklist ID to check against when adding leads
boolean
Skip adding the lead if it already exists in the list
boolean
Verify leads for the lead finder
boolean
Skip adding the lead if it already exists in the campaign
boolean
Skip adding the lead if it already exists in the workspace

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_API_KEYS_GETRetrieve a paginated list of organization API keys, including their key values, names, scopes, and timestamps.

Input Parameters

integer
Number of API keys to return per page, between 1 and 100
string
UUID cursor for pagination - pass the next_starting_after value from previous response to get next page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_BULK_ASSIGN_LEADSTool to bulk assign leads to organization users. Use when you need to assign multiple leads to specific organization members.

Input Parameters

array
required
List of lead UUIDs to assign to organization users
array
required
List of organization user UUIDs to assign the leads to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_CAMPAIGNS_ANALYTICS_OVERVIEW_GETTool 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.

Input Parameters

string
Campaign UUID to retrieve analytics for a single campaign. Leave empty for all campaigns.
array
List of campaign UUIDs to retrieve analytics for multiple campaigns.
string
End date for analytics range in YYYY-MM-DD format.
string
Start date for analytics range in YYYY-MM-DD format.
integer
Filter by campaign status (e.g., 1 = active).
boolean
When true, calculates total of all lead interest status events instead of only first occurrence. Affects: total_opportunities, total_interested, total_meeting_booked, total_meeting_completed, total_closed. Default: false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_CAMPAIGNS_FROM_EXPORT_POSTImport supplied campaign export data into a specified campaign.

Input Parameters

string
required
UUID identifier from the exported campaign data
string
required
Name of the campaign being imported
integer
required
Status code of the campaign; e.g., 0=Draft, 1=Active, 2=Paused, 3=Completed, 4=Running Subsequences, -99=Account Suspended, -1=Accounts Unhealthy, -2=Bounce Protect
string
required
UUID of the campaign to import the exported data into
string
required
UUID of the organization that owns the campaign
object
required
Campaign schedule configuration including schedules, start_date, and end_date
string
required
ISO 8601 timestamp when the campaign was originally created
string
required
ISO 8601 timestamp when the campaign was last updated

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_CHECK_DFY_EMAIL_ACCOUNT_ORDER_DOMAINSTool to check domain availability for DFY email account orders. Use when you need to validate domains before creating DFY email account orders.

Input Parameters

array
required
List of domain names to check for DFY email account order availability or validation. At least one domain is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_CHECK_EMAIL_VERIFICATION_STATUSTool to check status of an email verification job. Use after submitting a verification request to retrieve the current status of a specific email address.

Input Parameters

string
required
Email address to check verification status

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_COUNT_LAUNCHED_CAMPAIGNSTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_COUNT_LEADS_FROM_SUPERSEARCHTool 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.

Input Parameters

integer
Maximum number of leads to count
object
required
Filter criteria object containing professional attributes, company characteristics, and data source filters to count matching leads
boolean
When true, exclude leads previously acquired by your workspace

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_COUNT_UNREAD_EMAILSTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_CREATE_AI_ENRICHMENTTool to create an AI enrichment job for a campaign or lead list. Use when you need to enrich a resource with AI-driven insights.

Input Parameters

integer
Maximum number of leads to enrich (1–1,000,000)
string
Custom prompt to use (when template_id is not provided)
integer
Filter by job status: 1=pending, 2=processing, 3=completed, 4=failed
boolean
Whether to overwrite existing values in the output column
boolean
Return the current state of the enrichment job in the response
boolean
Automatically enrich new leads added after job creation
string
required
UUID of the resource (campaign or list) to enrich
integer
ID of a pre-defined prompt template to use
array
List of input column names to feed into the model
string
required
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
string
required
Column name to store the AI enrichment result
integer
required
Type of resource: 1 = List, 2 = Campaign
boolean
Whether to use Instantly’s own account for API calls
boolean
Skip leads that do not have an email address

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_CREATE_API_KEYCreates a new API key with specified permissions for the Instantly API. Use this tool to generate credentials for programmatic access. Each API key can be scoped with granular permissions (e.g., ‘campaigns:read’, ‘leads:create’) to limit access to specific resources and operations. The generated key value is returned in the response and should be stored securely. Common use cases: - Create integration keys with limited scopes for third-party applications - Generate read-only keys for reporting/analytics tools - Set up automation keys with specific resource access

Input Parameters

string
required
Human-readable name to identify this API key. Should be descriptive of its purpose or the application/integration using it. This name will appear in API key listings.
array
required
List of permission scopes for the API key. Each scope follows the format ‘resource:action’ (e.g., ‘campaigns:read’, ‘leads:create’). Use ‘all:all’ for full access to all resources. Common resources include: campaigns, leads, accounts, webhooks, api_keys, workspaces, subsequences, lead_lists, custom_tags, block_list_entries, emails, and more. Common actions include: create, read, update, delete, all.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_CREATE_BLOCK_LIST_ENTRYTool 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.

Input Parameters

string
required
The email address or domain to block (e.g., ‘user@example.com’ or ‘example.com’). The API automatically determines if it’s a domain or email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_CREATE_CAMPAIGNCreate a new campaign with its schedule and optional campaign settings.

Input Parameters

string
required
Name of the campaign
array
CC list
array
BCC list
string
Owner ID
number
Value of every positive lead
number
Gap between emails in minutes
array
Email sequences. Only the first element is used by the API. Each sequence contains steps, where each step must have: (1) type=‘email’, (2) delay (days before NEXT email, defaults to 0 if omitted), (3) variants list with subject and body for each variant.
boolean
Send as text-only
array
Email addresses of pre-configured sending accounts in your Instantly workspace. These must be accounts already added to your workspace, not arbitrary email addresses. Use the INSTANTLY_LIST_ACCOUNTS action to discover valid email addresses.
integer
Daily sending limit
boolean
Whether the campaign is evergreen
Track link clicks
boolean
Track opens
boolean
Stop campaign on reply
array
Tag IDs to use for sending
boolean
Match lead by ESP
integer
Max new leads to contact daily
number
Max random wait in minutes
boolean
Stop for company on reply
object
required
Schedule configuration for the campaign
boolean
Stop on auto-reply
object
Auto variant select settings
boolean
Allow risky contacts
boolean
Prioritize new leads
boolean
First email as text-only
boolean
Disable bounce protect
array
Provider routing rules
boolean
Insert unsubscribe header

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_CREATE_CUSTOM_TAGTool to create a new custom tag for organizing accounts and campaigns. Use when you need to create a new tag for categorization purposes.

Input Parameters

string
required
The label/name for the custom tag
string
A description for the tag to provide additional context

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_CREATE_INBOX_PLACEMENT_TESTTool to create an inbox placement test. Use when you need to measure deliverability across providers with your prepared email and recipient list.

Input Parameters

string
required
Name of the inbox placement test
array
List of tag UUIDs to apply to the test
integer ("1" | "2")
required
Test type: 1=one-time, 2=automated
array
required
List of recipient email addresses for the test
integer ("1" | "2" | "3")
Initial status: 1=Active, 2=Paused, 3=Completed
object
Schedule settings for automated inbox placement tests.
string
External identifier for tests sent from outside Instantly
boolean
If true, send plain-text only and disable open tracking
string
required
HTML body of the test email
array
Automations to trigger based on test results or schedule
string
UUID of the campaign to associate with the test
string
Optional description of the test
integer ("1" | "2")
Delivery mode: 1=one by one, 2=all together
string
required
Subject line for the test email
integer ("1" | "2")
required
Sending method: 1=From Instantly, 2=From outside Instantly
boolean
If true, trigger the test immediately in addition to schedule
array
Label settings for email service providers; fetch options via GET /inbox-placement-tests/email-service-provider-options
string ("daily_limits_hit" | "other")
Reason for not sending: ‘daily_limits_hit’ or ‘other’
string
Next run timestamp in ISO 8601 format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_CREATE_LEADTool to create a new lead. Use when you need to add an individual lead to a campaign.

Input Parameters

string
Email address of the lead
string
Phone number of the lead
string
Website URL of the lead
string
UUID of the campaign to associate the lead with
string
Last name of the lead
string
First name of the lead
string
Company name of the lead
string
Personalized note or message for the lead
object
Custom variables for the lead as a key/value map. Values must be scalars (string, number, boolean, or null); nested objects or arrays are not allowed. These will be stored on the lead’s payload and can be used in campaigns.
integer ("-3" | "-2" | "-1" | "0" | "1" | "2" | "3" | "4")
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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_CREATE_LEAD_LISTTool to create a new lead list. Use when you need to organize leads into a dedicated list before importing them into campaigns.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_CREATE_SUBSEQUENCECreates an automated follow-up subsequence for a campaign. Subsequences are triggered when leads meet specific conditions (CRM status changes, activities, or reply keywords). Use this tool when you need to: - Set up automatic follow-ups for interested leads (CRM status = 1) - Send targeted sequences when leads reply with specific keywords - Create different follow-up paths based on meeting status or lead activities - Implement A/B testing with multiple email variants Key features: - Condition-based triggering (CRM status, lead activity, or reply keywords) - Flexible scheduling with timezone support and active days - Multi-step email sequences with configurable delays - A/B testing support with multiple email variants per step

Input Parameters

string
required
Descriptive name for the subsequence to identify its purpose
array
required
List of sequences containing email steps. Important: Only the first sequence element is used by the API; additional elements are ignored.
object
required
Trigger conditions that determine when leads enter the subsequence. At least one of crm_status, lead_activity, or reply_contains must be provided (non-empty).
string
required
UUID of the parent campaign that this subsequence belongs to. Must be a valid existing campaign ID.
object
required
Scheduling configuration including timing windows, active days, timezone, and optional start/end dates

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_CREATE_SUPERSEARCH_ENRICHMENTTool 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.

Input Parameters

string ("work_email_enrichment" | "fully_enriched_profile" | "email_verification" | "joblisting" | "technologies" | "news" | "funding" | "ai_enrichment")
required
Type of enrichment to create
integer
Maximum number of leads to enrich
array
List of specific lead IDs to enrich (1-10000 items)
boolean
When true, automatically enriches new leads added to the campaign/list
string
required
UUID of the resource (list or campaign) to run enrichments for
array
List of column names to use as input data for AI enrichment from your leads
string
Version of the AI model to use for enrichment
object
Configuration options for enrichment types.
boolean
When true, overwrites existing values; when false, only enriches empty fields
boolean
When true, uses Instantly’s account for API calls; when false, uses your own API keys
boolean
When true, leads without an email will be skipped

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_CREATE_WEBHOOKTool to create a new webhook endpoint. Use when you need to receive Instantly event notifications via HTTP callbacks.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_DELETE_API_KEYTool to delete an API key. Use when you need to remove a specific API key by its ID after confirming its existence.

Input Parameters

string
required
UUID of the API key to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_DELETE_BLOCK_LIST_ENTRYTool to delete a blocked email or domain entry by its ID. Use when you need to remove a specific block list entry.

Input Parameters

string
required
UUID of the block list entry to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_DELETE_CAMPAIGNTool to delete a campaign. Use when you need to remove a specific campaign by ID.

Input Parameters

string
required
UUID of the campaign to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_DELETE_CUSTOM_TAGTool 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.

Input Parameters

string
required
UUID of the custom tag to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_DELETE_LEADTool to delete a lead by its ID. Use when you need to remove a specific lead after confirming its existence.

Input Parameters

string
required
UUID of the lead to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_DELETE_LEAD_LABELTool to delete a lead label by ID. Use when you need to remove a custom label for categorizing and managing leads.

Input Parameters

string
required
UUID of the lead label to delete
integer
The interest status to reassign leads and emails to when deleting this label

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_DELETE_LEAD_LISTTool to delete a lead list by ID. Use when you need to remove a specific lead list after confirming its existence.

Input Parameters

string
required
UUID of the lead list to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_DELETE_SUBSEQUENCEDelete a campaign subsequence by its UUID. The response may include subsequence details, but can be empty.

Input Parameters

string
required
UUID of the subsequence to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_DELETE_WEBHOOKTool to delete a webhook. Use when you need to remove a specific webhook by its UUID.

Input Parameters

string
required
UUID of the webhook to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_DELETE_WHITELABEL_DOMAINTool to delete the whitelabel domain from current workspace. Use when you need to remove the whitelabel domain configuration from a workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_DFY_EMAIL_ACCOUNT_ORDERS_DOMAINS_PRE_WARMED_UPTool 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.

Input Parameters

Search string to filter domains by partial or full domain name match
array
List of domain extensions (TLDs) to filter results. Only .com, .org, and .co are supported. Defaults to [‘com’, ‘org’, ‘co’] if not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_DISABLE_ACCOUNT_WARMUPStart a background job to disable warm-up for specific email accounts or all accounts, with optional exclusions when selecting all accounts. Returns the job’s status and progress.

Input Parameters

array
List of emails to disable warmup for (max 100).
array
List of emails to exclude when include_all_emails is true (max 100).
boolean
If true, disable warmup on all accounts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_DUPLICATE_CAMPAIGNTool to duplicate an existing campaign. Use when you need to create a copy of a campaign with the same configuration.

Input Parameters

string
required
UUID of the campaign to duplicate

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_DUPLICATE_SUBSEQUENCETool 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.

Input Parameters

string
required
UUID of the subsequence to duplicate
string
required
Name for the duplicated subsequence
string
required
UUID of the campaign to duplicate the subsequence to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_ENABLE_ACCOUNT_WARMUPEnable warm-up for specified email accounts or for all email accounts in the workspace, with optional exclusions for the workspace-wide selection. The operation returns a background job.

Input Parameters

array
List of email addresses to enable warmup for; max 100 items
array
List of email addresses to exclude when include_all_emails is true; max 100 items
boolean
If true, enable warmup for all email accounts in the workspace

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_EXPORT_CAMPAIGNTool to export campaign data to JSON format. Use when you need to retrieve complete campaign configuration for backup or migration.

Input Parameters

string
required
UUID of the campaign to export

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_ACCOUNT_CAMPAIGN_MAPPINGSTool to retrieve campaigns associated with an email account. Use when you need to find which campaigns are mapped to a specific email address.

Input Parameters

string
required
Email address to query for campaign associations
integer
Number of results to return for pagination
string
Pagination cursor that accepts UUID, timestamp (ISO 8601 format), or email for retrieving subsequent results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_ACCOUNTS_ANALYTICS_DAILYTool to retrieve daily account analytics showing emails sent per day for each account. Use when you need per-day performance metrics for email accounts.

Input Parameters

array
Filter by specific email accounts. If not provided, returns data for all accounts in workspace
string
End date for analytics period in YYYY-MM-DD format. If not provided, defaults to current date
string
Start date for analytics period in YYYY-MM-DD format. If not provided, returns data for the last 30 days

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_ACCOUNTS_WARMUP_ANALYTICSTool to retrieve warmup analytics for specified email accounts. Use when you need daily and aggregate warmup statistics including health scores.

Input Parameters

array
required
List of email addresses to retrieve warmup analytics for. The emails must be attached to accounts in your workspace

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_AUDIT_LOGSTool to retrieve audit log records for tracking system activities. Use when you need to review account activity history or monitor changes.

Input Parameters

integer
Maximum number of audit log entries to return, between 1 and 100
string
Cursor for pagination. Use ‘next_starting_after’ from previous response

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_BACKGROUND_JOBRetrieve the status, progress, and requested result fields for a background job.

Input Parameters

string
required
Opaque ID of the background job to retrieve
string
Comma-separated fields to include from the job data object. For move-leads jobs, moved_lead_emails is capped at 10,000 entries.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_BLOCK_LIST_ENTRYTool 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.

Input Parameters

string
required
UUID of the block list entry to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_CAMPAIGNTool to retrieve campaign details. Use when you need full campaign configuration for a given campaign ID.

Input Parameters

string
required
UUID of the campaign to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_CAMPAIGN_ANALYTICSTool to retrieve analytics for campaigns. Use when you need performance metrics for one or multiple campaigns.

Input Parameters

string
Campaign UUID to retrieve analytics for a single campaign
array
List of campaign UUIDs to retrieve analytics for multiple campaigns
string
End date filter (YYYY-MM-DD)
string
Start date filter (YYYY-MM-DD)
boolean
If true, exclude total leads count to speed response

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_CAMPAIGN_SENDING_STATUSTool 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.

Input Parameters

string
required
UUID of the campaign to retrieve sending status for
boolean
If true, includes an AI-generated summary of the sending status in the response. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_CAMPAIGN_STEPS_ANALYTICSTool 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.

Input Parameters

string
required
End date for analytics period in YYYY-MM-DD format (e.g., ‘2024-01-01’)
string
required
Start date for analytics period in YYYY-MM-DD format (e.g., ‘2024-01-01’)
string
Campaign ID in UUID format (e.g., ‘019b0aee-b8b9-7e26-ab5f-4fca02ce11f8’). Leave empty to get analytics for all campaigns
boolean
Whether to include opportunities count per step. When true, ‘opportunities’ and ‘unique_opportunities’ fields will be included in the response

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_CURRENT_WORKSPACETool to retrieve current workspace details based on API key. Use when you need workspace information like plan details, owner, or organization settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_CUSTOM_TAGTool to retrieve a specific custom tag by ID. Use when you need details about a custom tag used for organizing accounts and campaigns.

Input Parameters

string
required
UUID of the custom tag to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_CUSTOM_TAG_MAPPINGSTool 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.

Input Parameters

integer
Number of custom tag mappings to return, between 1 and 100
string
Comma-separated tag IDs to filter mappings by
string
Comma-separated resource IDs (account or campaign) to filter mappings by
string
Cursor ID to start listing after for pagination

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_DAILY_CAMPAIGN_ANALYTICSTool to retrieve daily analytics for a campaign. Use when you need per-day performance metrics for campaigns.

Input Parameters

string
End date (inclusive) for analytics in YYYY-MM-DD format
string
Start date (inclusive) for analytics in YYYY-MM-DD format
string
Campaign ID (UUID); omit to retrieve analytics for all campaigns
integer ("0" | "1" | "2" | "3" | "4" | "-99" | "-1" | "-2")
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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_DFY_EMAIL_ACCOUNT_ORDER_ACCOUNTSTool 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.

Input Parameters

integer
Number of accounts to return, between 1 and 100. Default is 10.
string
ID of the last item in the previous page for pagination. Can be UUID, timestamp, or email.
boolean
When set to true, the password of the account is returned. Can be empty if accounts are not ready yet.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_EMAIL_SERVICE_PROVIDER_OPTIONSTool to retrieve email service provider options for inbox placement tests. Use when you need valid recipients_labels options.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_INBOX_PLACEMENT_ANALYTICS_STATS_BY_DATETool 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.

Input Parameters

string
required
The unique identifier (UUID format) of the inbox placement test

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_INBOX_PLACEMENT_TESTRetrieve details of a specific inbox placement test by ID, with optional campaign and tag metadata.

Input Parameters

string
required
UUID of the inbox placement test
boolean
Whether to include campaign and tags metadata in response

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_LEADTool to retrieve details of a specific lead by its ID. Use when you have the lead UUID and need full lead metadata.

Input Parameters

string
required
UUID of the lead

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_LEAD_LABELTool to retrieve a specific lead label by ID. Use when you need details about a custom label for categorizing and managing leads.

Input Parameters

string
required
UUID of the lead label to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_LEAD_LABELSDEPRECATED: Use INSTANTLY_GET_LEAD_LABEL instead. Tool to retrieve a specific lead label by ID. Use when you need details about a custom label for categorizing and managing leads.

Input Parameters

string
required
UUID of the lead label to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_LEAD_LISTTool to retrieve details of a specific lead list by its ID. Use when you have the lead list UUID and need list metadata.

Input Parameters

string
required
UUID of the lead list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_PHONE_NUMBERSTool to retrieve all phone numbers associated with your organization. Use when you need to list phone numbers configured for CRM actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_SIMILAR_DFY_EMAIL_ACCOUNT_ORDER_DOMAINSTool 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.

Input Parameters

string
required
The base domain name to find similar alternatives for (e.g., ‘example.com’)
array
Array of TLD extensions to use for generating similar domains. Supported values: ‘com’, ‘org’. Default: [‘com’, ‘org’] if not specified. Maximum of 66 suggestions per extension.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_SUBSEQUENCETool to retrieve a specific subsequence by its ID. Use when you need full details of a follow-up sequence entity.

Input Parameters

string
required
UUID of the subsequence to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_SUBSEQUENCE_ANALYTICSReturn per-subsequence sent, opened, and replied totals for one campaign.

Input Parameters

string
required
UUID of the campaign whose subsequence analytics to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_SUPERSEARCH_ENRICHMENTTool to retrieve supersearch enrichment configuration and status for a list or campaign. Use this to check enrichment settings, progress status, and configuration details for a specific list or campaign resource.

Input Parameters

string
required
UUID of the list or campaign to retrieve enrichment configuration and status for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_VERIFICATION_STATS_FOR_LEAD_LISTTool to retrieve verification statistics for a lead list. Use when you need summary counts by verification status for a specific lead list.

Input Parameters

string
required
UUID of the lead list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_WEBHOOKTool to retrieve details of a specific webhook subscription. Use when you have the webhook ID and need full webhook configuration.

Input Parameters

string
required
UUID of the webhook

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_WEBHOOK_EVENTTool to retrieve details of a specific webhook event. Use when you need to inspect a particular webhook event by its ID.

Input Parameters

string
required
UUID of the webhook event to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_WEBHOOK_EVENTS_SUMMARYTool to retrieve webhook events summary with success and failure statistics. Use when you need aggregated webhook delivery metrics for a date range.

Input Parameters

string
required
Inclusive end date of the date range in YYYY-MM-DD format
string
required
Inclusive start date of the date range in YYYY-MM-DD format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_WEBHOOK_EVENTS_SUMMARY_BY_DATETool to retrieve webhook event summaries grouped by date. Use when you need aggregated webhook event statistics over a date range.

Input Parameters

string
required
End date (inclusive) in YYYY-MM-DD format for the summary period
string
required
Start date (inclusive) in YYYY-MM-DD format for the summary period

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_WEBHOOK_EVENT_TYPESTool to retrieve all available webhook event types. Use when you need to see valid event types for webhook subscriptions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_GET_WORKSPACE_BILLING_PLAN_DETAILSRetrieve workspace billing plan details, including available outreach subscription information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_INBOX_PLACEMENT_ANALYTICS_DELIVERABILITY_INSIGHTSTool 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.

Input Parameters

string
End date for filtering results in ISO 8601 format
string
required
The unique identifier for the inbox placement test (UUID)
string
Start date for filtering results in ISO 8601 format
array
Filter by recipient email service providers
array
Filter by recipient geographic locations
boolean
Whether to include previous period data in response
array
Filter by recipient types
string
End date for previous period comparison in ISO 8601 format
string
Start date for previous period comparison in ISO 8601 format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_INBOX_PLACEMENT_ANALYTICS_STATS_BY_TEST_IDTool 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.

Input Parameters

string
End date for filtering results in ISO 8601 format
array
required
Array of test IDs (UUIDs) to retrieve statistics for. Must be non-empty.
string
Start date for filtering results in ISO 8601 format
string
Filter by sender email address
array
Filter by recipient email service provider
array
Filter by recipient geographic locations
array
Filter by recipient type

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_LEAD_LABELS_POSTTool 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.

Input Parameters

string
required
The display name for the custom lead label
string
Detailed description of the lead label’s purpose
boolean
Whether this label should be used with AI features
string ("positive" | "negative" | "neutral")
required
Interest status category for this label. Must be one of: ‘positive’, ‘negative’, ‘neutral’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_LIST_ACCOUNTSTool to list all email accounts for the authenticated user. Use after obtaining auth credentials to retrieve available accounts.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_LIST_API_KEYSDEPRECATED: Use INSTANTLY_INSTANTLY_API_KEYS_GET instead. Tool to list all API keys. Use when you need to retrieve your API keys with optional pagination after authentication.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_LIST_BACKGROUND_JOBSList and filter asynchronous background jobs with cursor pagination.

Input Parameters

string
Comma-separated background job IDs to match
string ("move-leads" | "import-leads" | "export-leads" | "update-warmup-accounts" | "rename-variable" | "broadcast-ai-generate" | "broadcast-website-scrape" | "import-subscribers-from-crm" | "resync-subscriber-crm-tags" | "journey-ai-build")
Type of background job
integer
Number of background jobs to return, between 1 and 100
string
Comma-separated job statuses: pending, in-progress, success, failed, draining, paused, or cancelled
string
Comma-separated IDs of entities related to the jobs
string ("asc" | "desc")
Order used to sort results
string ("list" | "campaign" | "workspace" | "broadcast" | "subscriber-group-sync" | "subscriber-group" | "journey")
Type of entity related to the job
string ("created_at" | "updated_at")
Timestamp column used to sort results
string
Comma-separated background job IDs to exclude
string
Comma-separated background job IDs to include
string
Opaque cursor returned as next_starting_after by a previous page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_LIST_BLOCK_LIST_ENTRIESTool 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.

Input Parameters

integer
Number of items per page (1-100)
string
Search filter by email or domain value
boolean
Filter to return only domain blocks (true) or include both domains and specific emails (false/null)
string
Cursor for pagination - ID of last item from previous page (UUID format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_LIST_CAMPAIGNSTool to list all campaigns. Use when you need to fetch your campaigns list with optional filters and pagination.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_LIST_CUSTOM_TAGSTool to list custom tags. Use when you need to retrieve custom tags with optional pagination and filtering.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_LIST_DFY_EMAIL_ACCOUNT_ORDERSTool to list DFY email account orders. Use when you need to fetch your DFY email account orders with pagination.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_LIST_EMAILSTool to list emails. Use when you need to retrieve emails with optional filters and pagination.

Input Parameters

string
Filter by lead email address
string ("emode_focused" | "emode_others" | "emode_all")
Unibox mode filter: emode_focused, emode_others, or emode_all
integer
Number of items to return, between 1 and 100
string
Search by lead email or ‘thread:<thread_id>’ to filter by thread
string
Email account used to send the email
integer
Email status to filter by
boolean
Filter only unread emails
string ("received" | "sent" | "manual")
Filter by email type: received, sent, or manual
string ("asc" | "desc")
Sort order: asc or desc
string
Filter by assignee user ID
string
Campaign ID (UUID) to filter emails
boolean
Filter emails that have a reminder set
boolean
Filter preview-only emails
string
Filter by lead company domain
boolean
Filter emails marked as done
boolean
Return only scheduled emails
string
Cursor ID to start listing from for pagination

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_LIST_INBOX_PLACEMENT_BLACKLIST_SPAM_ASSASSINTool to list inbox placement blacklist & SpamAssassin reports. Use when you need to retrieve spam and blacklist analytics after running an inbox placement test.

Input Parameters

integer
Number of items to return, between 1 and 100
string
Filter items created at or before this timestamp (ISO 8601)
string
required
Inbox Placement Test ID to filter by
string
Filter items created at or after this timestamp (ISO 8601)
string
Cursor of last item from previous page for pagination
boolean
If true, omit blacklist_report from each item
boolean
If true, omit spam_assassin_report from each item

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_LIST_INBOX_PLACEMENT_TESTSTool to list inbox placement tests. Use when you need a paginated overview of tests with optional filtering and sort order.

Input Parameters

integer
Number of tests to return, between 1 and 100
string
Search term to filter tests by name or content
integer ("1" | "2" | "3")
Filter by status: 1=Active, 2=Paused, 3=Completed
string ("asc" | "desc")
Sort order by id (UUIDv7 timestamp); asc or desc
string
UUID cursor to start listing after for pagination

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_LIST_LEAD_LISTSTool to list all lead lists. Use when you need to fetch the lead lists with optional filters and pagination.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_LIST_LEADSTool to list leads. Use when you need to retrieve leads with optional filters like search, status filters, and pagination.

Input Parameters

array
Only include these lead IDs (UUID strings)
integer
Page size limit between 1 and 100
string
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
string
Search by first name, last name, or email
boolean
Whether the lead is in any list
string
Lead list ID to filter leads
array
Advanced query conditions as raw JSON objects
string
Campaign ID to filter leads
array
Only include leads with these emails
boolean
Whether the lead is in any campaign
array
Exclude these lead IDs (UUID strings)
string
Cursor of last item from previous page for pagination

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_LIST_SUBSEQUENCESList subsequences for or outside one campaign with cursor pagination.

Input Parameters

integer
Number of subsequences to return, between 1 and 100
string
Search text used to filter subsequences
string
Opaque cursor returned as next_starting_after by a previous page
string
UUID of the campaign whose subsequences should be returned
string
UUID of a campaign to exclude when returning reusable subsequences from other campaigns

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_LIST_WEBHOOK_EVENTSList webhook delivery events with optional filters and pagination.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_LIST_WEBHOOKSTool to list configured webhooks. Use when you need to retrieve your webhook configurations with optional filters and pagination.

Input Parameters

integer
Number of webhooks to return, between 1 and 100
string
Filter webhooks by campaign UUID
string
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.
string
Cursor (webhook ID) to start listing after for pagination

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_MARK_THREAD_AS_READTool 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.

Input Parameters

string
required
UUID of the email thread to mark as read

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_MERGE_LEADSTool to merge multiple leads into a single lead. Use after confirming both source and destination lead IDs exist.

Input Parameters

string
required
UUID of the source lead to be merged
string
required
UUID of the destination lead that will receive merged data

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_MOVE_LEADSTool to move leads from one campaign to another. Use when you need to transfer specific leads between campaigns.

Input Parameters

array
required
List of lead UUIDs to move to the destination campaign
string
required
UUID of the source campaign from which leads will be moved
string
required
UUID of the destination campaign to which leads will be moved

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_MOVE_LEAD_TO_SUBSEQUENCEMove one existing lead into a campaign follow-up subsequence.

Input Parameters

string
required
UUID of the lead to move
string
required
UUID of the destination subsequence

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_PATCH_LEAD_LABELTool to update an existing lead label by ID. Use when you need to modify a custom label for categorizing and managing leads.

Input Parameters

string
required
UUID of the lead label to update
string
Display label/name for the custom lead label (e.g., ‘Hot Lead’)
string
Detailed description of the custom lead label purpose
boolean
Whether this label should be used with AI features
string
Interest status label associated with this label (e.g., ‘positive’, ‘negative’, ‘neutral’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_PATCH_SUPERSEARCH_ENRICHMENT_SETTINGSTool 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.

Input Parameters

boolean
When true, will overwrite existing values in the output column. When false, only empty fields will be enriched. Default is false
boolean
When true, new leads added to the campaign/list will be automatically enriched using these same settings. Allows you to auto-update existing rows and keeps outputs fresh over time
string
required
Unique identifier (UUID) for the resource (list or campaign) to update enrichment settings for
boolean
Whether the enrichment is evergreen (automatically updates over time)
boolean
When true, leads without an email will be skipped. Enabled by default to ensure only leads with work email will be enriched, preventing credit waste for leads without work emails

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_PATCH_WEBHOOKTool to update an existing webhook configuration. Use when you need to modify webhook properties like name, event type, or target URL.

Input Parameters

string
required
UUID of the webhook to update.
string
Name for the webhook, or null to clear.
object
Custom headers to include in webhook requests (key-value pairs).
string
Campaign UUID to associate with the webhook, or null to clear.
string
Type of event to trigger the webhook. Options include: ‘all_events’ (subscribes to all events including custom label events), ‘email_sent’, ‘email_opened’, ‘email_link_clicked’, ‘reply_received’, ‘email_bounced’, ‘lead_unsubscribed’, ‘campaign_completed’, ‘account_error’, ‘lead_neutral’, and additional event types. Set to null for custom label events.
string
The URL where webhook events will be sent; must start with http:// or https://
integer
Integer value for custom interest; corresponds to LeadLabel.interest_status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_PAUSE_CAMPAIGNTool to pause an active campaign. Use when you need to suspend sending operations for a specific campaign.

Input Parameters

string
required
UUID of the campaign to pause

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_PAUSE_SUBSEQUENCETool to pause an active campaign subsequence. Use when you need to temporarily suspend a follow-up sequence.

Input Parameters

string
required
UUID of the subsequence to pause

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_REMOVE_LEAD_FROM_SUBSEQUENCETool to remove a lead from a campaign subsequence. Use when you need to stop a lead from receiving subsequence emails.

Input Parameters

string
required
The unique identifier (UUID format) of the lead to remove from the subsequence

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_RESUME_SUBSEQUENCETool to resume a paused campaign subsequence. Use when you need to restart a previously paused follow-up sequence.

Input Parameters

string
required
UUID of the subsequence to resume

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_SEARCH_CAMPAIGNS_BY_LEAD_EMAILTool to search campaigns by a lead’s email address. Use when you need to find campaigns containing a specific lead by their email.

Input Parameters

string
required
Lead email to search
string ("asc" | "desc")
Sort direction, either ‘asc’ or ‘desc’ (default ‘asc’)
string
Column to sort by, default ‘timestamp_created’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_SET_WHITELABEL_DOMAINTool to set whitelabel agency domain for current workspace. Use when you need to configure custom branding with your own domain name for the workspace.

Input Parameters

string
required
The agency domain to set for the workspace whitelabel configuration

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_SHARE_CAMPAIGNTool to share a campaign. Use when you need to share a campaign template for 7 days.

Input Parameters

string
required
UUID of the campaign to share

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_SUPERSEARCH_ENRICHMENT_RUN_POSTTool to run all enrichments for resource leads or unenriched leads. Use when you need to trigger enrichment processes for a list or campaign.

Input Parameters

string
required
The unique identifier (UUID) of the list or campaign to run enrichment for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_TEST_ACCOUNTS_VITALSTool to test IMAP/SMTP connectivity and account vitals for email accounts. Use when you need to verify email account health and connectivity status.

Input Parameters

array
required
Array of email addresses to test for IMAP/SMTP connectivity and account vitals

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_TEST_WEBHOOKTool to send a test payload to verify a webhook is working. Use when you need to verify a webhook configuration.

Input Parameters

string
required
UUID of the webhook to test

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_TOGGLE_RESOURCETool 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.

Input Parameters

boolean
required
Whether to assign (true) or unassign (false) the tags to the specified resources
object
Filter criteria to apply to resources. Only used when selected_all is true
array
required
Array of tag IDs to assign or unassign to resources
array
required
Array of resource IDs (account IDs or campaign IDs) to apply the tags to
boolean
Whether to select all resources. When true, the filter parameter is used
integer
required
Type of resource to apply tags to. Value: 1 for accounts or campaigns

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_UPDATE_BLOCK_LIST_ENTRYTool to update a blocked email or domain entry. Use when you need to modify the bl_value of an existing block list entry.

Input Parameters

string
required
UUID of the block list entry to update
string
required
The email address or domain to block (e.g., ‘example@domain.com’ or ‘example.com’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_UPDATE_CAMPAIGNTool to update details of a campaign. Use when you need to modify campaign settings after verifying its ID.

Input Parameters

string
required
UUID of the campaign to update
string
New campaign name
array
List of email addresses to CC
array
List of email addresses to BCC
string
UUID of the new owner; null to unset
number
Value for each positive lead; null to unset
integer
Gap between emails in minutes; null to unset
array
List of sequence objects; only first is honored; include steps inside
boolean
Send emails as text-only; null to unset
array
List of sender email addresses to use for this campaign. Must be email addresses of sender accounts that already exist in your Instantly workspace. Use INSTANTLY_LIST_ACCOUNTS to retrieve available sender email addresses.
integer
Daily send limit; null for unlimited
boolean
Whether the campaign is evergreen; null to unset
Enable link click tracking; null to unset
boolean
Enable open tracking; null to unset
boolean
Stop campaign when a lead replies; null to unset
array
List of email tag UUIDs to apply
boolean
Match leads by ESP; null to unset
integer
Max new leads to contact per day; null to unset
integer
Maximum random wait in minutes; null to unset
boolean
Stop for company on reply; null to unset
object
Raw campaign schedule configuration
boolean
Stop on auto-reply; null to unset
object
Settings for auto variant selection
boolean
Allow sending to risky contacts; null to unset
boolean
Prioritize new leads; null to unset
boolean
Send only the first email as text-only; null to unset
boolean
Disable bounce protection; null to unset
array
Custom provider routing rule objects
boolean
Insert unsubscribe header; null to unset

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_UPDATE_CUSTOM_TAGTool 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.

Input Parameters

string
required
UUID of the custom tag to update
string
The label/name for the custom tag. Include only if you want to update it.
string
A description for the tag to provide additional context. Include only if you want to update it. Set to empty string to clear.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_UPDATE_INBOX_PLACEMENT_TESTTool to update an inbox placement test. Use when you need to modify an existing inbox placement test by its ID.

Input Parameters

string
required
UUID of the inbox placement test to update
string
Name of the inbox placement test
array
List of tag UUIDs to apply to the test
integer ("1" | "2")
Test type: 1=one-time, 2=automated
array
List of recipient email addresses for the test
integer ("1" | "2" | "3")
Status: 1=Active, 2=Paused, 3=Completed
object
Schedule settings for automated inbox placement tests.
string
External identifier for tests sent from outside Instantly
boolean
If true, send plain-text only and disable open tracking
string
HTML body of the test email
array
Automations to trigger based on test results or schedule
string
UUID of the campaign to associate with the test
string
Optional description of the test
integer ("1" | "2")
Delivery mode: 1=one by one, 2=all together
string
Subject line for the test email
integer ("1" | "2")
Sending method: 1=From Instantly, 2=From outside Instantly
array
Label settings for email service providers; fetch options via GET /inbox-placement-tests/email-service-provider-options
string ("daily_limits_hit" | "other")
Reason for not sending: ‘daily_limits_hit’ or ‘other’
string
Next run timestamp in ISO 8601 format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_UPDATE_LEADTool to update a lead’s details. Use when you need to modify fields of an existing lead after identifying its ID.

Input Parameters

string
required
UUID of the lead to update.
string
Phone number of the lead, or null to clear.
string
Website URL of the lead, or null to clear.
string
Last name of the lead, or null to clear.
string
First name of the lead, or null to clear.
string
Company name of the lead, or null to clear.
string
Personalization content for the lead, or null to clear.
integer
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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_UPDATE_LEAD_INTEREST_STATUSSubmit an update to set or reset lead interest status by email, optionally scoped to a campaign or list. A successful response acknowledges an accepted update request, not necessarily completion.

Input Parameters

string
Optional list ID to scope the update
string
required
Email address of the lead whose interest status to update
string
Optional campaign ID to scope the update
string
required
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
integer
Optional AI interest value for the lead
boolean
Disable Instantly’s automatic interest updates when set to true

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_UPDATE_LEAD_LISTTool to update details of a specific lead list by its ID. Use after verifying the list ID exists.

Input Parameters

string
required
UUID of the lead list to update
string
New name for the lead list
string
User ID of the new owner (UUID)
boolean
Whether this list runs the enrichment process on every added lead

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_UPDATE_SUBSEQUENCETool to update a campaign subsequence entity. Use when you need to modify subsequence settings such as name, schedule, or triggered CRM statuses.

Input Parameters

string
required
UUID of the subsequence to update
string
Name of the subsequence
array
List of sequences containing email steps. Important: Only the first array element is processed, so provide only one array item with steps inside it.
array
Lead CRM statuses that trigger the subsequence
string
UUID of the campaign this subsequence belongs to
object
Schedule configuration for the subsequence.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_UPDATE_WORKSPACE_CURRENTTool to update the current workspace details. Use when you need to modify workspace settings such as name or logo URL.

Input Parameters

string
Name of the workspace
string
URL to the workspace logo. Set to null to remove the logo.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_VERIFY_EMAILTool to initiate email verification. Use when you need to verify an email’s deliverability before sending emails.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_WORKSPACE_GROUP_MEMBERS_ADMIN_GETTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_WORKSPACE_MEMBERS_GETTool 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.

Input Parameters

string
required
The unique identifier of the workspace member to retrieve (UUID format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTANTLY_WORKSPACE_MEMBERS_POSTTool 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.

Input Parameters

string ("editor" | "admin")
required
The role of the workspace member defining their access level. Available values: ‘editor’, ‘admin’. Note: ‘owner’ role cannot be created via API
string
required
Email address of the user to be added as a workspace member
array
Permissions for this workspace member used to restrict access to certain sections (e.g., [‘unibox.all’]). Can be null or omitted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not