Can I use Instantly as a CLI?

Yes. KosmoKrator exposes a Instantly CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose Instantly through MCP?

Yes. The KosmoKrator MCP gateway can expose selected Instantly tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are Instantly credentials stored?

Instantly credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for Instantly MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

productivity

Instantly Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Instantly KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.instantly.*. Use lua_read_doc("integrations.instantly") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic Instantly workflow without starting an interactive agent session.

Inline Lua call

kosmo integrations:lua --eval 'dump(app.integrations.instantly.activate_campaign({id = "example_id"}))' --json

Read Lua docs headlessly

kosmo integrations:lua --eval 'print(docs.read("instantly"))' --json
kosmo integrations:lua --eval 'print(docs.read("instantly.activate_campaign"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua

local instantly = app.integrations.instantly
local result = instantly.activate_campaign({id = "example_id"})

dump(result)

Run the workflow

kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json

Namespace note. integrations:lua exposes app.integrations.instantly, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.instantly.default.* or app.integrations.instantly.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need Instantly, use the narrower mcp:lua command.

MCP Lua command

# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

Instantly Integration

This integration targets the Instantly API v2 at https://api.instantly.ai/api/v2 and uses Bearer token authentication.

Coverage

The package exposes 181 tools. It covers the current official API v2 resource groups plus a small set of Instantly surfaces that remain present in this package for host compatibility:

Accounts, OAuth account connection, account-campaign mappings
Campaigns, campaign sharing/export/import, campaign variables, campaign analytics
Leads, lead lists, lead labels, interest status updates, subsequences
Emails, test email send, email verification, email templates
Block list entries, including bulk create/delete, delete-all, and CSV download
Webhooks and webhook events
Workspace, workspace members, workspace group members, workspace billing
Inbox placement tests, analytics, and reports
SuperSearch enrichment, custom tags, custom tag mappings
API keys, audit logs, background jobs, DFY email account orders, CRM phone-number actions
Compatibility tools for custom prompt templates and sales flows where host catalogs already expose them

Authentication

Create an Instantly API v2 key in Instantly workspace settings and store it as api_key.

Some endpoints require specific API scopes. OAuth account initialization, account movement, API key management, workspace group member operations, and destructive block list operations often require elevated scopes or an admin workspace API key.

Pagination

Most list tools accept:

limit
starting_after

Pass the returned cursor from one page into starting_after to continue pagination. Keep page sizes modest when an agent will inspect the output directly.

Common Input Formats

Tools prefer Instantly’s current snake_case field names. Several tools also accept comma-separated strings for convenience where the official API expects arrays, such as emails, ids, bl_values, account_ids, and variables.

Complex objects such as campaign sequences, campaign_schedule, enrichment filters, and sales flow payloads may be passed as JSON strings or native objects depending on the tool parameter.

Important Workflows

OAuth Account Connection

Use instantly_initialize_google_oauth or instantly_initialize_microsoft_oauth to get an auth_url and session_id. Send the user to auth_url, then poll instantly_get_oauth_session_status with the session ID until it returns success, error, or expired.

Test Email

Use instantly_send_test_email for preview sends. It requires:

eaccount
to_address_email_list
subject
html

The endpoint sends a test email and does not create an Unibox email entity.

Lead Interest Status

Use instantly_update_lead_interest_status with lead_email and interest_value. Add campaign_id or list_id when the workspace may contain the same lead in multiple places. Instantly submits this as a background job.

Block List Safety

Use bulk block list tools for large changes:

instantly_bulk_create_blocklist_entries with bl_values
instantly_bulk_delete_blocklist_entries with ids
instantly_download_blocklist_entries for CSV export

instantly_delete_all_blocklist_entries requires confirm=true. Use search or domains_only whenever possible to avoid broad workspace deletion.

Campaign Portability

Use:

instantly_share_campaign to enable sharing for a campaign
instantly_export_campaign to retrieve JSON campaign data
instantly_create_campaign_from_export to clone from a shared/exported campaign
instantly_add_campaign_variables to register variables on an existing campaign

Normalized Behavior

Analytics tools accept older aliases campaign_id, from, and to, but the service normalizes them to Instantly’s current query parameters id, start_date, and end_date before sending requests.

instantly_test_vitals sends the current accounts array payload. The older email shortcut remains available for compatibility and is converted to a one-item accounts array.

The block list CSV download returns raw CSV text, not JSON.

Raw agent markdown

# Instantly Integration

This integration targets the Instantly API v2 at `https://api.instantly.ai/api/v2` and uses Bearer token authentication.

## Coverage

The package exposes 181 tools. It covers the current official API v2 resource groups plus a small set of Instantly surfaces that remain present in this package for host compatibility:

- Accounts, OAuth account connection, account-campaign mappings
- Campaigns, campaign sharing/export/import, campaign variables, campaign analytics
- Leads, lead lists, lead labels, interest status updates, subsequences
- Emails, test email send, email verification, email templates
- Block list entries, including bulk create/delete, delete-all, and CSV download
- Webhooks and webhook events
- Workspace, workspace members, workspace group members, workspace billing
- Inbox placement tests, analytics, and reports
- SuperSearch enrichment, custom tags, custom tag mappings
- API keys, audit logs, background jobs, DFY email account orders, CRM phone-number actions
- Compatibility tools for custom prompt templates and sales flows where host catalogs already expose them

## Authentication

Create an Instantly API v2 key in Instantly workspace settings and store it as `api_key`.

Some endpoints require specific API scopes. OAuth account initialization, account movement, API key management, workspace group member operations, and destructive block list operations often require elevated scopes or an admin workspace API key.

## Pagination

Most list tools accept:

- `limit`
- `starting_after`

Pass the returned cursor from one page into `starting_after` to continue pagination. Keep page sizes modest when an agent will inspect the output directly.

## Common Input Formats

Tools prefer Instantly's current snake_case field names. Several tools also accept comma-separated strings for convenience where the official API expects arrays, such as `emails`, `ids`, `bl_values`, `account_ids`, and `variables`.

Complex objects such as campaign `sequences`, `campaign_schedule`, enrichment filters, and sales flow payloads may be passed as JSON strings or native objects depending on the tool parameter.

## Important Workflows

### OAuth Account Connection

Use `instantly_initialize_google_oauth` or `instantly_initialize_microsoft_oauth` to get an `auth_url` and `session_id`. Send the user to `auth_url`, then poll `instantly_get_oauth_session_status` with the session ID until it returns `success`, `error`, or `expired`.

### Test Email

Use `instantly_send_test_email` for preview sends. It requires:

- `eaccount`
- `to_address_email_list`
- `subject`
- `html`

The endpoint sends a test email and does not create an Unibox email entity.

### Lead Interest Status

Use `instantly_update_lead_interest_status` with `lead_email` and `interest_value`. Add `campaign_id` or `list_id` when the workspace may contain the same lead in multiple places. Instantly submits this as a background job.

### Block List Safety

Use bulk block list tools for large changes:

- `instantly_bulk_create_blocklist_entries` with `bl_values`
- `instantly_bulk_delete_blocklist_entries` with `ids`
- `instantly_download_blocklist_entries` for CSV export

`instantly_delete_all_blocklist_entries` requires `confirm=true`. Use `search` or `domains_only` whenever possible to avoid broad workspace deletion.

### Campaign Portability

Use:

- `instantly_share_campaign` to enable sharing for a campaign
- `instantly_export_campaign` to retrieve JSON campaign data
- `instantly_create_campaign_from_export` to clone from a shared/exported campaign
- `instantly_add_campaign_variables` to register variables on an existing campaign

## Normalized Behavior

Analytics tools accept older aliases `campaign_id`, `from`, and `to`, but the service normalizes them to Instantly's current query parameters `id`, `start_date`, and `end_date` before sending requests.

`instantly_test_vitals` sends the current `accounts` array payload. The older `email` shortcut remains available for compatibility and is converted to a one-item `accounts` array.

The block list CSV download returns raw CSV text, not JSON.

Metadata-derived Lua example

local result = app.integrations.instantly.activate_campaign({id = "example_id"})
print(result)

Functions

activate_campaign Write

Activate a campaign to start sending emails.

Lua path: app.integrations.instantly.activate_campaign
Full name: instantly.instantly_activate_campaign

Parameter	Type	Required	Description
`id`	string	yes	Campaign ID

add_campaign_variables Write

Add custom variables to an existing campaign.

Lua path: app.integrations.instantly.add_campaign_variables
Full name: instantly.instantly_add_campaign_variables

Parameter	Type	Required	Description
`id`	string	yes	Campaign ID
`variables`	array	yes	Variable names to add to the campaign

ai_enrichment_progress Read

Get AI enrichment progress for a resource.

Lua path: app.integrations.instantly.ai_enrichment_progress
Full name: instantly.instantly_ai_enrichment_progress

Parameter	Type	Required	Description
`resource_id`	string	yes	Resource ID

analytics_campaign Read

Get campaign analytics including sends, opens, clicks, replies, and bounces.

Lua path: app.integrations.instantly.analytics_campaign
Full name: instantly.instantly_analytics_campaign

Parameter	Type	Required	Description
`campaign_id`	string	yes	Campaign ID
`from`	string	no	Start date (YYYY-MM-DD)
`to`	string	no	End date (YYYY-MM-DD)

analytics_campaign_overview Read

Get overview analytics across all campaigns.

Lua path: app.integrations.instantly.analytics_campaign_overview
Full name: instantly.instantly_analytics_campaign_overview

Parameter	Type	Required	Description
`from`	string	no	Start date (YYYY-MM-DD)
`to`	string	no	End date (YYYY-MM-DD)

analytics_campaign_steps Read

Get campaign step analytics.

Lua path: app.integrations.instantly.analytics_campaign_steps
Full name: instantly.instantly_analytics_campaign_steps

Parameter	Type	Required	Description
`campaign_id`	string	yes	Campaign ID
`from`	string	no	Start date (YYYY-MM-DD)
`to`	string	no	End date (YYYY-MM-DD)

analytics_daily_account Read

Get daily account analytics breakdown.

Lua path: app.integrations.instantly.analytics_daily_account
Full name: instantly.instantly_analytics_daily_account

Parameter	Type	Required	Description
`from`	string	no	Start date (YYYY-MM-DD)
`to`	string	no	End date (YYYY-MM-DD)

analytics_daily_campaign Read

Get daily campaign analytics breakdown.

Lua path: app.integrations.instantly.analytics_daily_campaign
Full name: instantly.instantly_analytics_daily_campaign

Parameter	Type	Required	Description
`campaign_id`	string	yes	Campaign ID
`from`	string	no	Start date (YYYY-MM-DD)
`to`	string	no	End date (YYYY-MM-DD)

analytics_warmup Read

Get warmup analytics for email accounts.

Lua path: app.integrations.instantly.analytics_warmup
Full name: instantly.instantly_analytics_warmup

Parameter	Type	Required	Description
`emails`	array	yes	Email addresses to check

billing_plan_details Read

Get workspace plan details.

Lua path: app.integrations.instantly.billing_plan_details
Full name: instantly.instantly_billing_plan_details

Parameter	Type	Required	Description
No parameters.

billing_subscription_details Read

Get workspace subscription details.

Lua path: app.integrations.instantly.billing_subscription_details
Full name: instantly.instantly_billing_subscription_details

Parameter	Type	Required	Description
No parameters.

bulk_add_leads Write

Add leads in bulk to a campaign or list.

Lua path: app.integrations.instantly.bulk_add_leads
Full name: instantly.instantly_bulk_add_leads

Parameter	Type	Required	Description
`leads`	string	yes	JSON array of lead objects
`campaign_id`	string	no	Campaign ID
`list_id`	string	no	List ID
`skip_if_in_workspace`	boolean	no	Skip existing leads
`skip_if_in_campaign`	boolean	no	Skip leads in campaign

bulk_assign_leads Write

Bulk assign leads to organization users.

Lua path: app.integrations.instantly.bulk_assign_leads
Full name: instantly.instantly_bulk_assign_leads

Parameter	Type	Required	Description
`organization_user_ids`	string	yes	Comma-separated user IDs
`campaign`	string	no	Campaign ID filter
`list_id`	string	no	List ID filter
`ids`	string	no	Comma-separated lead IDs
`limit`	integer	no	Max leads to assign

bulk_create_blocklist_entries Write

Create block list entries in bulk from domains or email addresses.

Lua path: app.integrations.instantly.bulk_create_blocklist_entries
Full name: instantly.instantly_bulk_create_blocklist_entries

Parameter	Type	Required	Description
`bl_values`	array	yes	Domains or email addresses to block

bulk_delete_blocklist_entries Write

Delete block list entries in bulk by entry ID.

Lua path: app.integrations.instantly.bulk_delete_blocklist_entries
Full name: instantly.instantly_bulk_delete_blocklist_entries

Parameter	Type	Required	Description
`ids`	array	yes	Block list entry IDs to delete

bulk_delete_leads Write

Delete multiple leads in bulk.

Lua path: app.integrations.instantly.bulk_delete_leads
Full name: instantly.instantly_bulk_delete_leads

Parameter	Type	Required	Description
`campaign_id`	string	no	Campaign ID
`list_id`	string	no	List ID
`ids`	string	no	Comma-separated lead IDs
`status`	integer	no	Only delete leads with this status
`limit`	integer	no	Max leads to delete

campaign_sending_status Read

Get sending status and diagnostics for a campaign.

Lua path: app.integrations.instantly.campaign_sending_status
Full name: instantly.instantly_campaign_sending_status

Parameter	Type	Required	Description
`id`	string	yes	Campaign ID
`with_ai_summary`	boolean	no	Include AI summary

cancel_dfy_accounts Write

Cancel DFY email accounts.

Lua path: app.integrations.instantly.cancel_dfy_accounts
Full name: instantly.instantly_cancel_dfy_accounts

Parameter	Type	Required	Description
`accounts`	string	yes	Comma-separated emails to cancel

change_workspace_owner Write

Change the owner of the current workspace.

Lua path: app.integrations.instantly.change_workspace_owner
Full name: instantly.instantly_change_workspace_owner

Parameter	Type	Required	Description
`email`	string	yes	New owner email
`sec`	string	yes	Secret token

check_dfy_domains Read

Check domain availability for DFY orders.

Lua path: app.integrations.instantly.check_dfy_domains
Full name: instantly.instantly_check_dfy_domains

Parameter	Type	Required	Description
`domains`	string	yes	Comma-separated domains to check

count_launched_campaigns Read

Get the count of launched campaigns.

Lua path: app.integrations.instantly.count_launched_campaigns
Full name: instantly.instantly_count_launched_campaigns

Parameter	Type	Required	Description
No parameters.

create_account Write

Create a new email account via SMTP/IMAP credentials.

Lua path: app.integrations.instantly.create_account
Full name: instantly.instantly_create_account

Parameter	Type	Required	Description
`email`	string	yes	Email address
`first_name`	string	no	First name
`last_name`	string	no	Last name
`smtp_host`	string	yes	SMTP server host
`smtp_port`	integer	yes	SMTP port
`smtp_username`	string	yes	SMTP username
`smtp_password`	string	yes	SMTP password
`imap_host`	string	yes	IMAP host
`imap_port`	integer	yes	IMAP port
`imap_username`	string	yes	IMAP username
`imap_password`	string	yes	IMAP password
`daily_limit`	integer	no	Daily sending limit

create_ai_enrichment Write

Create AI enrichment for a resource. Uses AI models to generate custom columns.

Lua path: app.integrations.instantly.create_ai_enrichment
Full name: instantly.instantly_create_ai_enrichment

Parameter	Type	Required	Description
`resource_id`	string	yes	Resource ID
`output_column`	string	yes	Output column name
`resource_type`	integer	yes	Resource type
`model_version`	string	yes	AI model version
`input_columns`	string	no	Comma-separated input columns
`use_instantly_account`	boolean	no	Use Instantly account
`overwrite`	boolean	no	Overwrite existing values
`auto_update`	boolean	no	Auto-enrich new leads
`skip_leads_without_email`	boolean	no	Skip leads without email
`limit`	integer	no	Max leads to enrich
`prompt`	string	no	Custom AI prompt
`template_id`	integer	no	Prompt template ID

create_api_key Write

Create a new API key with specified scopes.

Lua path: app.integrations.instantly.create_api_key
Full name: instantly.instantly_create_api_key

Parameter	Type	Required	Description
`name`	string	yes	Key name
`scopes`	string	yes	Comma-separated scopes

create_blocklist_entry Write

Add an email or domain to the blocklist.

Lua path: app.integrations.instantly.create_blocklist_entry
Full name: instantly.instantly_create_blocklist_entry

Parameter	Type	Required	Description
`bl_value`	string	yes	Email or domain to block

create_campaign Write

Create a new campaign with full configuration including sequences, schedule, and sender accounts.

Lua path: app.integrations.instantly.create_campaign
Full name: instantly.instantly_create_campaign

Parameter	Type	Required	Description
`name`	string	yes	Campaign name
`open_tracking`	boolean	no	Enable open tracking
`link_tracking`	boolean	no	Enable link tracking
`text_only`	boolean	no	Plain text only
`stop_on_reply`	boolean	no	Stop on reply
`stop_on_auto_reply`	boolean	no	Stop on auto-reply
`daily_limit`	integer	no	Max emails/day per account
`email_gap`	integer	no	Minutes between emails
`email_list`	array	no	Sender email addresses
`sequences`	string	no	JSON sequences array
`campaign_schedule`	string	no	JSON schedule object

create_campaign_from_export Write

Create a new campaign from a shared/exported campaign ID.

Lua path: app.integrations.instantly.create_campaign_from_export
Full name: instantly.instantly_create_campaign_from_export

Parameter	Type	Required	Description
`id`	string	yes	Shared/exported campaign ID

create_custom_prompt_template Write

Create a new custom prompt template for AI enrichment.

Lua path: app.integrations.instantly.create_custom_prompt_template
Full name: instantly.instantly_create_custom_prompt_template

Parameter	Type	Required	Description
`name`	string	yes	Template name
`prompt`	string	yes	Prompt text with {{property}} placeholders
`category`	integer	yes	1=Copywriting,2=Cleaning,3=Sales,4=Marketing,5=Other,6=Personalization
`is_public`	boolean	yes	Public visibility
`description`	string	no	Description
`model_version`	string	no	Model version
`template_type`	string	no	custom or public
`from_shared`	boolean	no	Cloned from shared

create_custom_tag Write

Create a new custom tag for organizing accounts and campaigns.

Lua path: app.integrations.instantly.create_custom_tag
Full name: instantly.instantly_create_custom_tag

Parameter	Type	Required	Description
`label`	string	yes	Tag label
`description`	string	no	Tag description

create_dfy_order Write

Place a DFY email account order.

Lua path: app.integrations.instantly.create_dfy_order
Full name: instantly.instantly_create_dfy_order

Parameter	Type	Required	Description
`items`	string	yes	JSON order items
`order_type`	string	yes	dfy, pre_warmed_up, or extra_accounts
`simulation`	boolean	no	Simulate without ordering

create_email_template Write

Create an email template.

Lua path: app.integrations.instantly.create_email_template
Full name: instantly.instantly_create_email_template

Parameter	Type	Required	Description
`template_name`	string	yes	Template name
`subject`	string	yes	Email subject
`body`	string	yes	Email body
`category`	string	no	Category

create_enrichment Write

Create an enrichment for a resource (campaign or lead list).

Lua path: app.integrations.instantly.create_enrichment
Full name: instantly.instantly_create_enrichment

Parameter	Type	Required	Description
`resource_id`	string	yes	Resource ID
`type`	string	yes	Enrichment type
`limit`	integer	no	Max leads to enrich
`filters`	string	no	JSON filters
`custom_flow`	string	no	JSON custom flow

create_inbox_placement_test Write

Create an inbox placement test. Send test emails to check deliverability.

Lua path: app.integrations.instantly.create_inbox_placement_test
Full name: instantly.instantly_create_inbox_placement_test

Parameter	Type	Required	Description
`name`	string	yes	Test name
`type`	integer	yes	0=one-time, 1=automated
`sending_method`	integer	yes	0=Instantly, 1=external
`email_subject`	string	yes	Email subject
`email_body`	string	yes	Email body
`emails`	string	yes	Comma-separated seed emails

create_lead Write

Create a single lead.

Lua path: app.integrations.instantly.create_lead
Full name: instantly.instantly_create_lead

Parameter	Type	Required	Description
`email`	string	yes	Lead email
`campaign_id`	string	no	Campaign ID
`list_id`	string	no	List ID
`first_name`	string	no	First name
`last_name`	string	no	Last name
`company_name`	string	no	Company
`website`	string	no	Website
`phone`	string	no	Phone

create_lead_label Write

Create a new lead label (custom interest status).

Lua path: app.integrations.instantly.create_lead_label
Full name: instantly.instantly_create_lead_label

Parameter	Type	Required	Description
`label_name`	string	yes	Label name
`color`	string	no	Hex color
`icon`	string	no	Icon name
`value`	integer	no	Numeric value

create_lead_list Write

Create a new lead list.

Lua path: app.integrations.instantly.create_lead_list
Full name: instantly.instantly_create_lead_list

Parameter	Type	Required	Description
`name`	string	yes	List name

create_sales_flow Write

Create a sales flow.

Lua path: app.integrations.instantly.create_sales_flow
Full name: instantly.instantly_create_sales_flow

Parameter	Type	Required	Description
`body`	string	no	JSON sales flow definition

create_subsequence Write

Create a new subsequence for a campaign.

Lua path: app.integrations.instantly.create_subsequence
Full name: instantly.instantly_create_subsequence

Parameter	Type	Required	Description
`parent_campaign`	string	yes	Campaign ID
`name`	string	yes	Subsequence name
`conditions`	string	yes	JSON trigger conditions
`subsequence_schedule`	string	yes	JSON schedule config
`sequences`	string	yes	JSON sequences array

create_webhook Write

Create a new webhook subscription.

Lua path: app.integrations.instantly.create_webhook
Full name: instantly.instantly_create_webhook

Parameter	Type	Required	Description
`target_hook_url`	string	yes	Target URL
`event_type`	string	no	Event type (e.g. lead_interested)
`campaign`	string	no	Campaign ID filter
`name`	string	no	Webhook name

create_whitelabel Write

Set the agency domain (whitelabel) for the workspace.

Lua path: app.integrations.instantly.create_whitelabel
Full name: instantly.instantly_create_whitelabel

Parameter	Type	Required	Description
`domain`	string	yes	Agency domain

create_workspace_group_member Write

Create or invite a workspace group member.

Lua path: app.integrations.instantly.create_workspace_group_member
Full name: instantly.instantly_create_workspace_group_member

Parameter	Type	Required	Description
`email`	string	yes	Member email

create_workspace_member Write

Invite a new member to the workspace.

Lua path: app.integrations.instantly.create_workspace_member
Full name: instantly.instantly_create_workspace_member

Parameter	Type	Required	Description
`email`	string	yes	Member email
`role`	string	yes	Role (admin, member)

ctd_status Read

Get custom tracking domain (CTD) status. Check SSL and CNAME configuration.

Lua path: app.integrations.instantly.ctd_status
Full name: instantly.instantly_ctd_status

Parameter	Type	Required	Description
`host`	string	yes	Tracking domain host

delete_account Write

Delete an email account by ID.

Lua path: app.integrations.instantly.delete_account
Full name: instantly.instantly_delete_account

Parameter	Type	Required	Description
`id`	string	yes	Account ID

delete_all_blocklist_entries Write

Delete all block list entries matching optional filters. Requires confirm=true.

Lua path: app.integrations.instantly.delete_all_blocklist_entries
Full name: instantly.instantly_delete_all_blocklist_entries

Parameter	Type	Required	Description
`confirm`	boolean	yes	Must be true to perform this destructive operation
`domains_only`	boolean	no	Only delete domain blocklist entries
`search`	string	no	Only delete entries matching this value

delete_api_key Write

Delete an API key by ID.

Lua path: app.integrations.instantly.delete_api_key
Full name: instantly.instantly_delete_api_key

Parameter	Type	Required	Description
`id`	string	yes	API key ID

delete_blocklist_entry Write

Remove an entry from the blocklist.

Lua path: app.integrations.instantly.delete_blocklist_entry
Full name: instantly.instantly_delete_blocklist_entry

Parameter	Type	Required	Description
`id`	string	yes	Entry ID

delete_campaign Write

Delete a campaign by ID.

Lua path: app.integrations.instantly.delete_campaign
Full name: instantly.instantly_delete_campaign

Parameter	Type	Required	Description
`id`	string	yes	Campaign ID

delete_custom_prompt_template Write

Delete a custom prompt template.

Lua path: app.integrations.instantly.delete_custom_prompt_template
Full name: instantly.instantly_delete_custom_prompt_template

Parameter	Type	Required	Description
`id`	string	yes	Template ID

delete_custom_tag Write

Delete a custom tag by ID.

Lua path: app.integrations.instantly.delete_custom_tag
Full name: instantly.instantly_delete_custom_tag

Parameter	Type	Required	Description
`id`	string	yes	Tag ID

delete_email Write

Delete an email.

Lua path: app.integrations.instantly.delete_email
Full name: instantly.instantly_delete_email

Parameter	Type	Required	Description
`id`	string	yes	Email ID

delete_email_template Write

Delete an email template.

Lua path: app.integrations.instantly.delete_email_template
Full name: instantly.instantly_delete_email_template

Parameter	Type	Required	Description
`id`	string	yes	Template ID

delete_inbox_placement_test Write

Delete an inbox placement test.

Lua path: app.integrations.instantly.delete_inbox_placement_test
Full name: instantly.instantly_delete_inbox_placement_test

Parameter	Type	Required	Description
`id`	string	yes	Test ID

delete_lead Write

Delete a lead by ID.

Lua path: app.integrations.instantly.delete_lead
Full name: instantly.instantly_delete_lead

Parameter	Type	Required	Description
`id`	string	yes	Lead ID

delete_lead_label Write

Delete a lead label.

Lua path: app.integrations.instantly.delete_lead_label
Full name: instantly.instantly_delete_lead_label

Parameter	Type	Required	Description
`id`	string	yes	Label ID
`new_label`	string	no	Label ID to reassign leads to

delete_lead_list Write

Delete a lead list by ID.

Lua path: app.integrations.instantly.delete_lead_list
Full name: instantly.instantly_delete_lead_list

Parameter	Type	Required	Description
`id`	string	yes	List ID

delete_phone_number Write

Delete a CRM phone number.

Lua path: app.integrations.instantly.delete_phone_number
Full name: instantly.instantly_delete_phone_number

Parameter	Type	Required	Description
`id`	string	yes	Phone number ID

delete_sales_flow Write

Delete a sales flow.

Lua path: app.integrations.instantly.delete_sales_flow
Full name: instantly.instantly_delete_sales_flow

Parameter	Type	Required	Description
`id`	string	yes	Sales flow ID

delete_subsequence Write

Delete a subsequence by ID.

Lua path: app.integrations.instantly.delete_subsequence
Full name: instantly.instantly_delete_subsequence

Parameter	Type	Required	Description
`id`	string	yes	Subsequence ID

delete_webhook Write

Delete a webhook by ID.

Lua path: app.integrations.instantly.delete_webhook
Full name: instantly.instantly_delete_webhook

Parameter	Type	Required	Description
`id`	string	yes	Webhook ID

delete_whitelabel Write

Delete the whitelabel domain.

Lua path: app.integrations.instantly.delete_whitelabel
Full name: instantly.instantly_delete_whitelabel

Parameter	Type	Required	Description
No parameters.

delete_workspace_group_member Write

Delete a workspace group member.

Lua path: app.integrations.instantly.delete_workspace_group_member
Full name: instantly.instantly_delete_workspace_group_member

Parameter	Type	Required	Description
`id`	string	yes	Member ID

delete_workspace_member Write

Remove a member from the workspace.

Lua path: app.integrations.instantly.delete_workspace_member
Full name: instantly.instantly_delete_workspace_member

Parameter	Type	Required	Description
`id`	string	yes	Member ID

deliverability_insights Read

Get deliverability insights for an inbox placement test.

Lua path: app.integrations.instantly.deliverability_insights
Full name: instantly.instantly_deliverability_insights

Parameter	Type	Required	Description
`test_id`	string	yes	Test ID
`date_from`	string	no	Start date
`date_to`	string	no	End date
`previous_date_from`	string	no	Previous start
`previous_date_to`	string	no	Previous end
`show_previous`	boolean	no	Show comparison
`recipient_geo`	string	no	Geo filter
`recipient_type`	string	no	Type filter
`recipient_esp`	string	no	ESP filter

download_blocklist_entries Read

Download block list entries as CSV text.

Lua path: app.integrations.instantly.download_blocklist_entries
Full name: instantly.instantly_download_blocklist_entries

Parameter	Type	Required	Description
`domains_only`	boolean	no	Only include domain blocklist entries
`search`	string	no	Only include entries matching this value

duplicate_campaign Write

Duplicate a campaign.

Lua path: app.integrations.instantly.duplicate_campaign
Full name: instantly.instantly_duplicate_campaign

Parameter	Type	Required	Description
`id`	string	yes	Campaign ID to duplicate
`name`	string	no	Name for the copy

duplicate_subsequence Write

Duplicate a subsequence to the same or different campaign.

Lua path: app.integrations.instantly.duplicate_subsequence
Full name: instantly.instantly_duplicate_subsequence

Parameter	Type	Required	Description
`id`	string	yes	Subsequence ID
`parent_campaign`	string	yes	Target campaign ID
`name`	string	yes	Name for copy

email_unread_count Read

Get the count of unread emails.

Lua path: app.integrations.instantly.email_unread_count
Full name: instantly.instantly_email_unread_count

Parameter	Type	Required	Description
No parameters.

email_verification_status Read

Get email verification status for an address.

Lua path: app.integrations.instantly.email_verification_status
Full name: instantly.instantly_email_verification_status

Parameter	Type	Required	Description
`email`	string	yes	Email address

enrichment_count_leads Read

Count leads matching SuperSearch filters without importing them.

Lua path: app.integrations.instantly.enrichment_count_leads
Full name: instantly.instantly_enrichment_count_leads

Parameter	Type	Required	Description
`search_filters`	string	yes	JSON search filters

enrichment_enrich_leads Read

Enrich leads from SuperSearch. Import and enrich leads matching your search filters.

Lua path: app.integrations.instantly.enrichment_enrich_leads
Full name: instantly.instantly_enrichment_enrich_leads

Parameter	Type	Required	Description
`search_filters`	string	yes	JSON search filters
`limit`	integer	yes	Max leads to import

enrichment_history Read

Retrieve enrichment history for a resource.

Lua path: app.integrations.instantly.enrichment_history
Full name: instantly.instantly_enrichment_history

Parameter	Type	Required	Description
`resource_id`	string	yes	Resource ID

enrichment_preview_leads Read

Preview leads matching SuperSearch filters without importing.

Lua path: app.integrations.instantly.enrichment_preview_leads
Full name: instantly.instantly_enrichment_preview_leads

Parameter	Type	Required	Description
`search_filters`	string	yes	JSON search filters

export_campaign Read

Export a campaign to JSON format.

Lua path: app.integrations.instantly.export_campaign
Full name: instantly.instantly_export_campaign

Parameter	Type	Required	Description
`id`	string	yes	Campaign ID

forward_email Write

Forward an email.

Lua path: app.integrations.instantly.forward_email
Full name: instantly.instantly_forward_email

Parameter	Type	Required	Description
`lead_id`	string	yes	Lead ID
`campaign_id`	string	yes	Campaign ID
`forward_to`	string	yes	Recipient email
`forward_body`	string	no	Forward note

get_account Read

Get an email account by ID with full details including warmup status, sending limits, and vitals.

Lua path: app.integrations.instantly.get_account
Full name: instantly.instantly_get_account

Parameter	Type	Required	Description
`id`	string	yes	Account ID

get_account_mappings Read

Get campaigns associated with an email account.

Lua path: app.integrations.instantly.get_account_mappings
Full name: instantly.instantly_get_account_mappings

Parameter	Type	Required	Description
`email`	string	yes	Account email
`limit`	integer	no	Items per page
`starting_after`	string	no	Pagination cursor

get_background_job Read

Get a background job by ID.

Lua path: app.integrations.instantly.get_background_job
Full name: instantly.instantly_get_background_job

Parameter	Type	Required	Description
`id`	string	yes	Job ID
`data_fields`	string	no	Comma-separated data fields

get_blocklist_entry Read

Get a blocklist entry by ID.

Lua path: app.integrations.instantly.get_blocklist_entry
Full name: instantly.instantly_get_blocklist_entry

Parameter	Type	Required	Description
`id`	string	yes	Entry ID

get_campaign Read

Get a campaign by ID with full details.

Lua path: app.integrations.instantly.get_campaign
Full name: instantly.instantly_get_campaign

Parameter	Type	Required	Description
`id`	string	yes	Campaign ID

get_custom_prompt_template Read

Get a custom prompt template by ID.

Lua path: app.integrations.instantly.get_custom_prompt_template
Full name: instantly.instantly_get_custom_prompt_template

Parameter	Type	Required	Description
`id`	string	yes	Template ID

get_custom_tag Read

Get a custom tag by ID.

Lua path: app.integrations.instantly.get_custom_tag
Full name: instantly.instantly_get_custom_tag

Parameter	Type	Required	Description
`id`	string	yes	Tag ID

get_email Read

Get an email by ID.

Lua path: app.integrations.instantly.get_email
Full name: instantly.instantly_get_email

Parameter	Type	Required	Description
`id`	string	yes	Email ID

get_email_template Read

Get an email template by ID.

Lua path: app.integrations.instantly.get_email_template
Full name: instantly.instantly_get_email_template

Parameter	Type	Required	Description
`id`	string	yes	Template ID

get_enrichment Read

Get enrichment settings for a resource (campaign or lead list).

Lua path: app.integrations.instantly.get_enrichment
Full name: instantly.instantly_get_enrichment

Parameter	Type	Required	Description
`resource_id`	string	yes	Campaign or lead list ID

get_inbox_placement_analytics Read

Get a single inbox placement analytics entry.

Lua path: app.integrations.instantly.get_inbox_placement_analytics
Full name: instantly.instantly_get_inbox_placement_analytics

Parameter	Type	Required	Description
`id`	string	yes	Analytics entry ID

get_inbox_placement_report Read

Get an inbox placement report by ID.

Lua path: app.integrations.instantly.get_inbox_placement_report
Full name: instantly.instantly_get_inbox_placement_report

Parameter	Type	Required	Description
`id`	string	yes	Report ID

get_inbox_placement_test Read

Get an inbox placement test by ID.

Lua path: app.integrations.instantly.get_inbox_placement_test
Full name: instantly.instantly_get_inbox_placement_test

Parameter	Type	Required	Description
`id`	string	yes	Test ID
`with_metadata`	boolean	no	Include metadata

get_lead Read

Get a lead by ID.

Lua path: app.integrations.instantly.get_lead
Full name: instantly.instantly_get_lead

Parameter	Type	Required	Description
`id`	string	yes	Lead ID

get_lead_label Read

Get a lead label by ID.

Lua path: app.integrations.instantly.get_lead_label
Full name: instantly.instantly_get_lead_label

Parameter	Type	Required	Description
`id`	string	yes	Label ID

get_lead_list Read

Get a lead list by ID.

Lua path: app.integrations.instantly.get_lead_list
Full name: instantly.instantly_get_lead_list

Parameter	Type	Required	Description
`id`	string	yes	List ID

get_oauth_session_status Read

Get the status of a Google or Microsoft OAuth account connection session.

Lua path: app.integrations.instantly.get_oauth_session_status
Full name: instantly.instantly_get_oauth_session_status

Parameter	Type	Required	Description
`session_id`	string	yes	OAuth session ID returned by the init endpoint

get_sales_flow Read

Get a sales flow by ID.

Lua path: app.integrations.instantly.get_sales_flow
Full name: instantly.instantly_get_sales_flow

Parameter	Type	Required	Description
`id`	string	yes	Sales flow ID

get_webhook Read

Get a webhook by ID.

Lua path: app.integrations.instantly.get_webhook
Full name: instantly.instantly_get_webhook

Parameter	Type	Required	Description
`id`	string	yes	Webhook ID

get_webhook_event Read

Get a webhook event by ID.

Lua path: app.integrations.instantly.get_webhook_event
Full name: instantly.instantly_get_webhook_event

Parameter	Type	Required	Description
`id`	string	yes	Event ID

get_whitelabel Read

Get whitelabel domain information.

Lua path: app.integrations.instantly.get_whitelabel
Full name: instantly.instantly_get_whitelabel

Parameter	Type	Required	Description
No parameters.

get_workspace Read

Get current workspace details based on your API key.

Lua path: app.integrations.instantly.get_workspace
Full name: instantly.instantly_get_workspace

Parameter	Type	Required	Description
No parameters.

get_workspace_group_member Read

Get a workspace group member by ID.

Lua path: app.integrations.instantly.get_workspace_group_member
Full name: instantly.instantly_get_workspace_group_member

Parameter	Type	Required	Description
`id`	string	yes	Member ID

get_workspace_group_members_admin Read

Get admin workspace group members.

Lua path: app.integrations.instantly.get_workspace_group_members_admin
Full name: instantly.instantly_get_workspace_group_members_admin

Parameter	Type	Required	Description
No parameters.

get_workspace_member Read

Get a workspace member by ID.

Lua path: app.integrations.instantly.get_workspace_member
Full name: instantly.instantly_get_workspace_member

Parameter	Type	Required	Description
`id`	string	yes	Member ID

inbox_placement_esp_options Read

Get available email service provider options for inbox placement tests.

Lua path: app.integrations.instantly.inbox_placement_esp_options
Full name: instantly.instantly_inbox_placement_esp_options

Parameter	Type	Required	Description
No parameters.

inbox_placement_stats_by_date Read

Get time series stats for inbox placement (inbox/spam/category distribution).

Lua path: app.integrations.instantly.inbox_placement_stats_by_date
Full name: instantly.instantly_inbox_placement_stats_by_date

Parameter	Type	Required	Description
`test_id`	string	yes	Test ID
`date_from`	string	no	Start date
`date_to`	string	no	End date
`recipient_geo`	string	no	Geo filter
`recipient_type`	string	no	Type filter
`recipient_esp`	string	no	ESP filter
`sender_email`	string	no	Sender email filter

inbox_placement_stats_by_test Read

Get aggregated inbox/spam/category counts for test IDs.

Lua path: app.integrations.instantly.inbox_placement_stats_by_test
Full name: instantly.instantly_inbox_placement_stats_by_test

Parameter	Type	Required	Description
`test_ids`	string	yes	Comma-separated test IDs
`date_from`	string	no	Start date
`date_to`	string	no	End date
`recipient_geo`	string	no	Geo filter
`recipient_type`	string	no	Type filter
`recipient_esp`	string	no	ESP filter
`sender_email`	string	no	Sender email filter

initialize_google_oauth Read

Initialize a Google OAuth account connection flow and return the authorization URL.

Lua path: app.integrations.instantly.initialize_google_oauth
Full name: instantly.instantly_initialize_google_oauth

Parameter	Type	Required	Description
No parameters.

initialize_microsoft_oauth Read

Initialize a Microsoft OAuth account connection flow and return the authorization URL.

Lua path: app.integrations.instantly.initialize_microsoft_oauth
Full name: instantly.instantly_initialize_microsoft_oauth

Parameter	Type	Required	Description
No parameters.

lead_list_verification_stats Read

Get email verification statistics for a lead list.

Lua path: app.integrations.instantly.lead_list_verification_stats
Full name: instantly.instantly_lead_list_verification_stats

Parameter	Type	Required	Description
`id`	string	yes	List ID

list_accounts Read

List all email accounts in the workspace. Returns email, status, warmup status, and sending limits.

Lua path: app.integrations.instantly.list_accounts
Full name: instantly.instantly_list_accounts

Parameter	Type	Required	Description
`limit`	integer	no	Items per page (1-100)
`starting_after`	string	no	Pagination cursor
`search`	string	no	Search by email
`status`	integer	no	Filter by status

list_api_keys Read

List all API keys in the workspace.

Lua path: app.integrations.instantly.list_api_keys
Full name: instantly.instantly_list_api_keys

Parameter	Type	Required	Description
`limit`	integer	no	Items per page
`starting_after`	string	no	Pagination cursor

list_audit_logs Read

List audit log records for tracking workspace activities.

Lua path: app.integrations.instantly.list_audit_logs
Full name: instantly.instantly_list_audit_logs

Parameter	Type	Required	Description
`limit`	integer	no	Items per page (1-1000)
`starting_after`	string	no	Pagination cursor
`activity_type`	integer	no	Activity type filter
`search`	string	no	Search term
`start_date`	string	no	Start date
`end_date`	string	no	End date

list_background_jobs Read

List background jobs. Track long-running tasks like bulk imports and exports.

Lua path: app.integrations.instantly.list_background_jobs
Full name: instantly.instantly_list_background_jobs

Parameter	Type	Required	Description
`limit`	integer	no	Items per page
`starting_after`	string	no	Pagination cursor
`ids`	string	no	Comma-separated job IDs
`type`	string	no	Job type
`entity_type`	string	no	Entity type
`entity_id`	string	no	Entity ID
`status`	string	no	Status filter
`sort_column`	string	no	Sort column
`sort_order`	string	no	Sort order (asc/desc)

list_blocklist Read

List all blocklist entries (blocked emails and domains).

Lua path: app.integrations.instantly.list_blocklist
Full name: instantly.instantly_list_blocklist

Parameter	Type	Required	Description
`limit`	integer	no	Items per page (1-100)
`starting_after`	string	no	Pagination cursor
`domains_only`	boolean	no	Only show domains
`search`	string	no	Search by email/domain

list_campaigns Read

List all campaigns in the workspace.

Lua path: app.integrations.instantly.list_campaigns
Full name: instantly.instantly_list_campaigns

Parameter	Type	Required	Description
`limit`	integer	no	Items per page (1-100)
`starting_after`	string	no	Pagination cursor
`status`	integer	no	0=Draft,1=Active,2=Paused,3=Completed
`search`	string	no	Search by name

list_custom_prompt_templates Read

List custom prompt templates.

Lua path: app.integrations.instantly.list_custom_prompt_templates
Full name: instantly.instantly_list_custom_prompt_templates

Parameter	Type	Required	Description
`limit`	integer	no	Items per page
`starting_after`	string	no	Pagination cursor
`search`	string	no	Search by name

list_custom_tag_mappings Read

List custom tag mappings showing which tags are on which resources.

Lua path: app.integrations.instantly.list_custom_tag_mappings
Full name: instantly.instantly_list_custom_tag_mappings

Parameter	Type	Required	Description
`limit`	integer	no	Items per page
`starting_after`	string	no	Pagination cursor
`resource_ids`	string	no	Comma-separated resource IDs

list_custom_tags Read

List custom tags used to organize accounts and campaigns.

Lua path: app.integrations.instantly.list_custom_tags
Full name: instantly.instantly_list_custom_tags

Parameter	Type	Required	Description
`limit`	integer	no	Items per page
`starting_after`	string	no	Pagination cursor
`search`	string	no	Search by label
`resource_ids`	string	no	Comma-separated resource IDs
`tag_ids`	string	no	Comma-separated tag IDs

list_dfy_accounts Read

List DFY ordered email accounts.

Lua path: app.integrations.instantly.list_dfy_accounts
Full name: instantly.instantly_list_dfy_accounts

Parameter	Type	Required	Description
`limit`	integer	no	Items per page
`starting_after`	string	no	Pagination cursor
`with_passwords`	boolean	no	Include passwords

list_dfy_orders Read

List DFY email account orders.

Lua path: app.integrations.instantly.list_dfy_orders
Full name: instantly.instantly_list_dfy_orders

Parameter	Type	Required	Description
`limit`	integer	no	Items per page
`starting_after`	string	no	Pagination cursor

list_email_templates Read

List email templates.

Lua path: app.integrations.instantly.list_email_templates
Full name: instantly.instantly_list_email_templates

Parameter	Type	Required	Description
`limit`	integer	no	Items per page
`starting_after`	string	no	Pagination cursor
`search`	string	no	Search by name

list_emails Read

List emails from the Unibox (unified inbox).

Lua path: app.integrations.instantly.list_emails
Full name: instantly.instantly_list_emails

Parameter	Type	Required	Description
`limit`	integer	no	Items per page
`starting_after`	string	no	Pagination cursor
`search`	string	no	Search by email
`campaign_id`	string	no	Filter by campaign
`label`	integer	no	Filter by label
`assigned_to`	string	no	Filter by assignee
`type`	string	no	Email type filter

list_inbox_placement_analytics Read

List inbox placement analytics for a test.

Lua path: app.integrations.instantly.list_inbox_placement_analytics
Full name: instantly.instantly_list_inbox_placement_analytics

Parameter	Type	Required	Description
`test_id`	string	yes	Test ID
`limit`	integer	no	Items per page
`starting_after`	string	no	Pagination cursor
`date_from`	string	no	Start date
`date_to`	string	no	End date
`recipient_geo`	string	no	Geo filter (comma-separated)
`recipient_type`	string	no	Type filter (comma-separated)
`recipient_esp`	string	no	ESP filter (comma-separated)

list_inbox_placement_reports Read

List inbox placement blacklist and SpamAssassin reports.

Lua path: app.integrations.instantly.list_inbox_placement_reports
Full name: instantly.instantly_list_inbox_placement_reports

Parameter	Type	Required	Description
`test_id`	string	yes	Test ID
`limit`	integer	no	Items per page
`starting_after`	string	no	Pagination cursor
`date_from`	string	no	Start date
`date_to`	string	no	End date
`skip_spam_assassin_report`	boolean	no	Skip SpamAssassin report
`skip_blacklist_report`	boolean	no	Skip blacklist report

list_inbox_placement_tests Read

List inbox placement tests.

Lua path: app.integrations.instantly.list_inbox_placement_tests
Full name: instantly.instantly_list_inbox_placement_tests

Parameter	Type	Required	Description
`limit`	integer	no	Items per page
`starting_after`	string	no	Pagination cursor
`search`	string	no	Search filter
`status`	integer	no	Status filter
`sort_order`	string	no	Sort order

list_lead_labels Read

List all lead labels (interest statuses) in the workspace.

Lua path: app.integrations.instantly.list_lead_labels
Full name: instantly.instantly_list_lead_labels

Parameter	Type	Required	Description
`limit`	integer	no	Items per page
`starting_after`	string	no	Pagination cursor

list_lead_lists Read

List all lead lists in the workspace.

Lua path: app.integrations.instantly.list_lead_lists
Full name: instantly.instantly_list_lead_lists

Parameter	Type	Required	Description
`limit`	integer	no	Items per page (1-100)
`starting_after`	string	no	Pagination cursor
`search`	string	no	Search by name

list_leads Read

List leads in a campaign or list.

Lua path: app.integrations.instantly.list_leads
Full name: instantly.instantly_list_leads

Parameter	Type	Required	Description
`campaign_id`	string	no	Campaign ID
`list_id`	string	no	List ID
`limit`	integer	no	Items per page (1-100)
`starting_after`	string	no	Pagination cursor
`search`	string	no	Search by email

list_phone_numbers Read

List CRM phone numbers.

Lua path: app.integrations.instantly.list_phone_numbers
Full name: instantly.instantly_list_phone_numbers

Parameter	Type	Required	Description
`limit`	integer	no	Items per page
`starting_after`	string	no	Pagination cursor

list_sales_flows Read

List sales flows.

Lua path: app.integrations.instantly.list_sales_flows
Full name: instantly.instantly_list_sales_flows

Parameter	Type	Required	Description
`limit`	integer	no	Items per page
`starting_after`	string	no	Pagination cursor

list_subsequences Read

List all subsequences for a campaign.

Lua path: app.integrations.instantly.list_subsequences
Full name: instantly.instantly_list_subsequences

Parameter	Type	Required	Description
`parent_campaign`	string	yes	Campaign ID
`limit`	integer	no	Items per page
`starting_after`	string	no	Pagination cursor
`search`	string	no	Search by name

list_webhook_events Read

List webhook events.

Lua path: app.integrations.instantly.list_webhook_events
Full name: instantly.instantly_list_webhook_events

Parameter	Type	Required	Description
`limit`	integer	no	Items per page (1-100)
`starting_after`	string	no	Pagination cursor
`success`	boolean	no	Filter by success
`from`	string	no	Start date (YYYY-MM-DD)
`to`	string	no	End date (YYYY-MM-DD)
`search`	string	no	Search by URL or email

list_webhooks Read

List all webhooks in the workspace.

Lua path: app.integrations.instantly.list_webhooks
Full name: instantly.instantly_list_webhooks

Parameter	Type	Required	Description
`limit`	integer	no	Items per page
`starting_after`	string	no	Pagination cursor
`campaign`	string	no	Filter by campaign
`event_type`	string	no	Filter by event type

list_workspace_group_members Read

List workspace group members.

Lua path: app.integrations.instantly.list_workspace_group_members
Full name: instantly.instantly_list_workspace_group_members

Parameter	Type	Required	Description
`limit`	integer	no	Items per page
`starting_after`	string	no	Pagination cursor

list_workspace_members Read

List all workspace members.

Lua path: app.integrations.instantly.list_workspace_members
Full name: instantly.instantly_list_workspace_members

Parameter	Type	Required	Description
No parameters.

mark_account_fixed Write

Mark an email account as fixed after resolving connection or sending errors.

Lua path: app.integrations.instantly.mark_account_fixed
Full name: instantly.instantly_mark_account_fixed

Parameter	Type	Required	Description
`email`	string	yes	Email to mark fixed

mark_email_read Write

Mark an email thread as read.

Lua path: app.integrations.instantly.mark_email_read
Full name: instantly.instantly_mark_email_read

Parameter	Type	Required	Description
`thread_id`	string	yes	Thread ID

merge_leads Write

Merge two leads into one.

Lua path: app.integrations.instantly.merge_leads
Full name: instantly.instantly_merge_leads

Parameter	Type	Required	Description
`lead_id`	string	yes	Source lead ID
`destination_lead_id`	string	yes	Destination lead ID

move_accounts Write

Move email accounts between workspaces. Requires an admin workspace API key.

Lua path: app.integrations.instantly.move_accounts
Full name: instantly.instantly_move_accounts

Parameter	Type	Required	Description
`emails`	array	yes	Email accounts to move
`source_workspace_id`	string	yes	Workspace ID the accounts currently belong to
`destination_workspace_id`	string	yes	Workspace ID the accounts should be moved to

move_leads Write

Move leads between campaigns.

Lua path: app.integrations.instantly.move_leads
Full name: instantly.instantly_move_leads

Parameter	Type	Required	Description
`lead_ids`	string	yes	Comma-separated lead IDs
`from_campaign_id`	string	no	Source campaign ID
`to_campaign_id`	string	yes	Destination campaign ID

pause_account Write

Pause an email account. Stops sending until resumed.

Lua path: app.integrations.instantly.pause_account
Full name: instantly.instantly_pause_account

Parameter	Type	Required	Description
`email`	string	yes	Email to pause

pause_campaign Write

Pause a running campaign.

Lua path: app.integrations.instantly.pause_campaign
Full name: instantly.instantly_pause_campaign

Parameter	Type	Required	Description
`id`	string	yes	Campaign ID

pause_subsequence Write

Pause a subsequence.

Lua path: app.integrations.instantly.pause_subsequence
Full name: instantly.instantly_pause_subsequence

Parameter	Type	Required	Description
`id`	string	yes	Subsequence ID

pre_warmed_domains Read

Get pre-warmed up domains available for order.

Lua path: app.integrations.instantly.pre_warmed_domains
Full name: instantly.instantly_pre_warmed_domains

Parameter	Type	Required	Description
`extensions`	string	no	Comma-separated extensions (com,org,co)
`search`	string	no	Search filter

remove_from_subsequence Write

Remove a lead from a subsequence.

Lua path: app.integrations.instantly.remove_from_subsequence
Full name: instantly.instantly_remove_from_subsequence

Parameter	Type	Required	Description
`id`	string	yes	Lead ID

reply_email Write

Reply to an email thread.

Lua path: app.integrations.instantly.reply_email
Full name: instantly.instantly_reply_to_email

Parameter	Type	Required	Description
`lead_id`	string	yes	Lead ID
`campaign_id`	string	yes	Campaign ID
`account_email`	string	no	Sender email
`reply_body`	string	yes	Reply content

resume_account Write

Resume a paused email account.

Lua path: app.integrations.instantly.resume_account
Full name: instantly.instantly_resume_account

Parameter	Type	Required	Description
`email`	string	yes	Email to resume

resume_subsequence Write

Resume a paused subsequence.

Lua path: app.integrations.instantly.resume_subsequence
Full name: instantly.instantly_resume_subsequence

Parameter	Type	Required	Description
`id`	string	yes	Subsequence ID

resume_webhook Write

Resume a disabled webhook.

Lua path: app.integrations.instantly.resume_webhook
Full name: instantly.instantly_resume_webhook

Parameter	Type	Required	Description
`id`	string	yes	Webhook ID

run_enrichment Write

Run enrichment for a campaign or lead list.

Lua path: app.integrations.instantly.run_enrichment
Full name: instantly.instantly_run_enrichment

Parameter	Type	Required	Description
`resource_id`	string	yes	Resource ID
`lead_ids`	string	no	Comma-separated lead IDs

search_campaigns_by_contact Read

Find campaigns containing a specific lead email.

Lua path: app.integrations.instantly.search_campaigns_by_contact
Full name: instantly.instantly_search_campaigns_by_contact

Parameter	Type	Required	Description
`search`	string	yes	Lead email to search
`sort_column`	string	no	Sort column
`sort_order`	string	no	Sort order (asc/desc)

send_test_email Write

Send a preview/test email from a connected email account without creating an Unibox email.

Lua path: app.integrations.instantly.send_test_email
Full name: instantly.instantly_send_test_email

Parameter	Type	Required	Description
`eaccount`	string	yes	Connected sender email account
`to_address_email_list`	string	yes	Comma-separated recipient email addresses
`subject`	string	yes	Test email subject
`html`	string	yes	HTML body of the test email
`text`	string	no	Optional text body

share_campaign Read

Share a campaign so other users can create a new campaign from it.

Lua path: app.integrations.instantly.share_campaign
Full name: instantly.instantly_share_campaign

Parameter	Type	Required	Description
`id`	string	yes	Campaign ID

similar_domains Read

Get similar domains for DFY orders.

Lua path: app.integrations.instantly.similar_domains
Full name: instantly.instantly_similar_domains

Parameter	Type	Required	Description
`body`	string	no	JSON request body

subsequence_move_leads Write

Move leads to a subsequence.

Lua path: app.integrations.instantly.subsequence_move_leads
Full name: instantly.instantly_subsequence_move_leads

Parameter	Type	Required	Description
`lead_ids`	string	yes	Comma-separated lead IDs
`subsequence_id`	string	yes	Target subsequence ID

subsequence_sending_status Read

Get the sending status of a subsequence.

Lua path: app.integrations.instantly.subsequence_sending_status
Full name: instantly.instantly_subsequence_sending_status

Parameter	Type	Required	Description
`id`	string	yes	Subsequence ID
`with_ai_summary`	boolean	no	Include AI summary

test_ai_label Write

Test AI reply label prediction. Returns predicted label for a given reply text.

Lua path: app.integrations.instantly.test_ai_label
Full name: instantly.instantly_test_ai_label

Parameter	Type	Required	Description
`reply_text`	string	yes	Reply text to classify

test_vitals Write

Test account vitals (DNS, SMTP, IMAP connectivity). Returns diagnostic results.

Lua path: app.integrations.instantly.test_vitals
Full name: instantly.instantly_test_vitals

Parameter	Type	Required	Description
`accounts`	array	no	Email accounts to test. If omitted, Instantly tests available accounts.
`email`	string	no	Deprecated single email shortcut. Prefer accounts.

test_webhook Write

Send a test payload to a webhook.

Lua path: app.integrations.instantly.test_webhook
Full name: instantly.instantly_test_webhook

Parameter	Type	Required	Description
`id`	string	yes	Webhook ID

toggle_custom_tags Write

Assign or unassign tags to resources (accounts or campaigns).

Lua path: app.integrations.instantly.toggle_custom_tags
Full name: instantly.instantly_toggle_custom_tags

Parameter	Type	Required	Description
`tag_ids`	string	yes	Comma-separated tag IDs
`resource_ids`	string	yes	Comma-separated resource IDs
`resource_type`	integer	yes	Resource type
`assign`	boolean	yes	true=assign, false=unassign

update_account Write

Update an email account. Modify daily limit, tracking domain, signature, and more.

Lua path: app.integrations.instantly.update_account
Full name: instantly.instantly_update_account

Parameter	Type	Required	Description
`email`	string	yes	Account email
`first_name`	string	no	First name
`last_name`	string	no	Last name
`daily_limit`	integer	no	Daily sending limit
`tracking_domain_name`	string	no	Tracking domain
`enable_slow_ramp`	boolean	no	Enable slow ramp up
`sending_gap`	integer	no	Minutes between emails (0-1440)
`signature`	string	no	Email signature
`remove_tracking_domain`	boolean	no	Remove tracking domain

update_blocklist_entry Write

Update a blocklist entry.

Lua path: app.integrations.instantly.update_blocklist_entry
Full name: instantly.instantly_update_blocklist_entry

Parameter	Type	Required	Description
`id`	string	yes	Entry ID
`bl_value`	string	no	New email or domain

update_campaign Write

Update an existing campaign configuration.

Lua path: app.integrations.instantly.update_campaign
Full name: instantly.instantly_update_campaign

Parameter	Type	Required	Description
`id`	string	yes	Campaign ID
`name`	string	no	Campaign name
`open_tracking`	boolean	no	Open tracking
`link_tracking`	boolean	no	Link tracking
`text_only`	boolean	no	Plain text only
`stop_on_reply`	boolean	no	Stop on reply
`daily_limit`	integer	no	Max emails/day
`email_gap`	integer	no	Minutes between emails
`email_list`	array	no	Sender emails
`sequences`	string	no	JSON sequences
`campaign_schedule`	string	no	JSON schedule

update_custom_prompt_template Write

Update a custom prompt template.

Lua path: app.integrations.instantly.update_custom_prompt_template
Full name: instantly.instantly_update_custom_prompt_template

Parameter	Type	Required	Description
`id`	string	yes	Template ID
`name`	string	no	Name
`prompt`	string	no	Prompt text
`category`	integer	no	Category
`is_public`	boolean	no	Public
`description`	string	no	Description
`model_version`	string	no	Model version
`template_type`	string	no	Type
`from_shared`	boolean	no	From shared

update_custom_tag Write

Update a custom tag.

Lua path: app.integrations.instantly.update_custom_tag
Full name: instantly.instantly_update_custom_tag

Parameter	Type	Required	Description
`id`	string	yes	Tag ID
`label`	string	no	New label
`description`	string	no	New description

update_email Write

Update an email (e.g., assign to a team member, update label).

Lua path: app.integrations.instantly.update_email
Full name: instantly.instantly_update_email

Parameter	Type	Required	Description
`id`	string	yes	Email ID
`assigned_to`	string	no	User ID to assign
`label`	integer	no	Label value

update_email_template Write

Update an email template.

Lua path: app.integrations.instantly.update_email_template
Full name: instantly.instantly_update_email_template

Parameter	Type	Required	Description
`id`	string	yes	Template ID
`template_name`	string	no	Template name
`subject`	string	no	Email subject
`body`	string	no	Email body
`category`	string	no	Category

update_enrichment_settings Write

Update enrichment settings for a resource.

Lua path: app.integrations.instantly.update_enrichment_settings
Full name: instantly.instantly_update_enrichment_settings

Parameter	Type	Required	Description
`resource_id`	string	yes	Resource ID
`auto_update`	boolean	no	Auto-enrich new leads
`skip_rows_without_email`	boolean	no	Skip leads without email

update_inbox_placement_test Write

Update an inbox placement test.

Lua path: app.integrations.instantly.update_inbox_placement_test
Full name: instantly.instantly_update_inbox_placement_test

Parameter	Type	Required	Description
`id`	string	yes	Test ID
`name`	string	no	Test name
`status`	integer	no	Test status

update_lead Write

Update a lead.

Lua path: app.integrations.instantly.update_lead
Full name: instantly.instantly_update_lead

Parameter	Type	Required	Description
`id`	string	yes	Lead ID
`first_name`	string	no	First name
`last_name`	string	no	Last name
`company_name`	string	no	Company
`website`	string	no	Website
`phone`	string	no	Phone
`personalization`	string	no	Personalization text
`lt_interest_status`	integer	no	Interest status
`pl_value_lead`	string	no	Potential value
`assigned_to`	string	no	User ID to assign

update_lead_interest_status Write

Update a lead interest status by lead email, optionally scoped to a campaign or list.

Lua path: app.integrations.instantly.update_lead_interest_status
Full name: instantly.instantly_update_lead_interest_status

Parameter	Type	Required	Description
`lead_email`	string	yes	Lead email address
`interest_value`	number	yes	Interest status value. Pass null to reset to Lead.
`campaign_id`	string	no	Campaign ID to scope the update
`list_id`	string	no	Lead list ID to scope the update
`ai_interest_value`	number	no	AI interest value to set
`disable_auto_interest`	boolean	no	Disable automatic interest updates for this lead

update_lead_label Write

Update a lead label.

Lua path: app.integrations.instantly.update_lead_label
Full name: instantly.instantly_update_lead_label

Parameter	Type	Required	Description
`id`	string	yes	Label ID
`label_name`	string	no	Label name
`color`	string	no	Hex color
`icon`	string	no	Icon name
`value`	integer	no	Numeric value

update_lead_list Write

Update a lead list name.

Lua path: app.integrations.instantly.update_lead_list
Full name: instantly.instantly_update_lead_list

Parameter	Type	Required	Description
`id`	string	yes	List ID
`name`	string	no	New list name

update_sales_flow Write

Update a sales flow.

Lua path: app.integrations.instantly.update_sales_flow
Full name: instantly.instantly_update_sales_flow

Parameter	Type	Required	Description
`id`	string	yes	Sales flow ID
`body`	string	no	JSON update data

update_subsequence Write

Update a subsequence.

Lua path: app.integrations.instantly.update_subsequence
Full name: instantly.instantly_update_subsequence

Parameter	Type	Required	Description
`id`	string	yes	Subsequence ID
`name`	string	no	New name

update_webhook Write

Update a webhook.

Lua path: app.integrations.instantly.update_webhook
Full name: instantly.instantly_update_webhook

Parameter	Type	Required	Description
`id`	string	yes	Webhook ID
`target_hook_url`	string	no	Target URL
`event_type`	string	no	Event type
`campaign`	string	no	Campaign ID
`name`	string	no	Webhook name
`custom_interest_value`	integer	no	Custom interest value

update_workspace Write

Update current workspace name or logo.

Lua path: app.integrations.instantly.update_workspace
Full name: instantly.instantly_update_workspace

Parameter	Type	Required	Description
`name`	string	no	Workspace name
`org_logo_url`	string	no	Logo URL

update_workspace_member Write

Update a workspace member role.

Lua path: app.integrations.instantly.update_workspace_member
Full name: instantly.instantly_update_workspace_member

Parameter	Type	Required	Description
`id`	string	yes	Member ID
`role`	string	no	New role

verify_email Write

Verify an email address. Returns deliverability status.

Lua path: app.integrations.instantly.verify_email
Full name: instantly.instantly_verify_email

Parameter	Type	Required	Description
`email`	string	yes	Email to verify
`webhook_url`	string	no	Webhook URL for results

warmup_disable Write

Disable warmup for email accounts.

Lua path: app.integrations.instantly.warmup_disable
Full name: instantly.instantly_warmup_disable

Parameter	Type	Required	Description
`account_ids`	array	yes	Account IDs to disable warmup for

warmup_enable Write

Enable warmup for email accounts. Gradually increases sending volume to build reputation.

Lua path: app.integrations.instantly.warmup_enable
Full name: instantly.instantly_warmup_enable

Parameter	Type	Required	Description
`account_ids`	array	yes	Account IDs to enable warmup for

webhook_event_types Read

List all available webhook event types.

Lua path: app.integrations.instantly.webhook_event_types
Full name: instantly.instantly_webhook_event_types

Parameter	Type	Required	Description
No parameters.

webhook_events_summary Read

Get overview aggregates for webhook events.

Lua path: app.integrations.instantly.webhook_events_summary
Full name: instantly.instantly_webhook_events_summary

Parameter	Type	Required	Description
`from`	string	no	Start date (YYYY-MM-DD)
`to`	string	no	End date (YYYY-MM-DD)

webhook_events_summary_by_date Read

Get webhook event aggregates grouped by date.

Lua path: app.integrations.instantly.webhook_events_summary_by_date
Full name: instantly.instantly_webhook_events_summary_by_date

Parameter	Type	Required	Description
`from`	string	no	Start date (YYYY-MM-DD)
`to`	string	no	End date (YYYY-MM-DD)