productivity
Instantly MCP, CLI, and Lua Integration for AI Agents
Instantly integration docs for AI agents: MCP gateway setup, Instantly CLI commands, Lua API reference, credentials, and function schemas.
181 functions 87 read 94 write API key auth
Instantly for agents
Credentials can be configured manually in web or CLI hosts.
Use this integration from Lua code mode, the headless integrations CLI, or the KosmoKrator MCP gateway. The same package metadata powers all three surfaces.
Machine-Readable Metadata
- integration_slug
instantly- route_slug
instantly- package
instantly- auth_strategy
api_keyAPI key- cli_setup_supported
true- cli_runtime_supported
true- mcp_gateway_supported
true- lua_supported
true- supports_multi_account
true
Quick Links
Lua APIAgent-facing namespace and function reference. Instantly CLIHeadless setup and direct function calls. Instantly MCPMCP gateway setup for external clients. Submit feedbackReport missing tools, auth problems, wrong docs, or runtime issues. ContributeAdd tools or improve metadata in the integrations repo.
Instantly MCP Client Matrix
Use these pages when a specific agent client or framework needs copy-pasteable MCP setup for Instantly.
Claude Code Instantly MCP setup for Claude Code. Cursor Instantly MCP setup for Cursor. Codex Instantly MCP setup for Codex. OpenAI Agents Instantly MCP setup for OpenAI Agents SDK. Claude Agent SDK Instantly MCP setup for Claude Agent SDK. Vercel AI SDK Instantly MCP setup for Vercel AI SDK. LangChain Instantly MCP setup for LangChain. LangGraph Instantly MCP setup for LangGraph. CrewAI Instantly MCP setup for CrewAI. MCP clients Instantly MCP setup for Generic MCP Clients.
Instantly CLI Matrix
Use these pages for direct Instantly CLI workflows in scripts, CI, cron, and agent wrappers.
CI Instantly CLI for CI. Cron Jobs Instantly CLI for cron jobs. Shell Scripts Instantly CLI for shell scripts. Headless Automation Instantly CLI for headless automation. Coding Agents Instantly CLI for coding agents.
Function Catalog
| Function | Type | Parameters | Description |
|---|---|---|---|
instantly.instantly_activate_campaign | Write write | 1 | Activate a campaign to start sending emails. |
instantly.instantly_add_campaign_variables | Write write | 2 | Add custom variables to an existing campaign. |
instantly.instantly_ai_enrichment_progress | Read read | 1 | Get AI enrichment progress for a resource. |
instantly.instantly_analytics_campaign | Read read | 3 | Get campaign analytics including sends, opens, clicks, replies, and bounces. |
instantly.instantly_analytics_campaign_overview | Read read | 2 | Get overview analytics across all campaigns. |
instantly.instantly_analytics_campaign_steps | Read read | 3 | Get campaign step analytics. |
instantly.instantly_analytics_daily_account | Read read | 2 | Get daily account analytics breakdown. |
instantly.instantly_analytics_daily_campaign | Read read | 3 | Get daily campaign analytics breakdown. |
instantly.instantly_analytics_warmup | Read read | 1 | Get warmup analytics for email accounts. |
instantly.instantly_billing_plan_details | Read read | 0 | Get workspace plan details. |
instantly.instantly_billing_subscription_details | Read read | 0 | Get workspace subscription details. |
instantly.instantly_bulk_add_leads | Write write | 5 | Add leads in bulk to a campaign or list. |
instantly.instantly_bulk_assign_leads | Write write | 5 | Bulk assign leads to organization users. |
instantly.instantly_bulk_create_blocklist_entries | Write write | 1 | Create block list entries in bulk from domains or email addresses. |
instantly.instantly_bulk_delete_blocklist_entries | Write write | 1 | Delete block list entries in bulk by entry ID. |
instantly.instantly_bulk_delete_leads | Write write | 5 | Delete multiple leads in bulk. |
instantly.instantly_campaign_sending_status | Read read | 2 | Get sending status and diagnostics for a campaign. |
instantly.instantly_cancel_dfy_accounts | Write write | 1 | Cancel DFY email accounts. |
instantly.instantly_change_workspace_owner | Write write | 2 | Change the owner of the current workspace. |
instantly.instantly_check_dfy_domains | Read read | 1 | Check domain availability for DFY orders. |
instantly.instantly_count_launched_campaigns | Read read | 0 | Get the count of launched campaigns. |
instantly.instantly_create_account | Write write | 12 | Create a new email account via SMTP/IMAP credentials. |
instantly.instantly_create_ai_enrichment | Write write | 12 | Create AI enrichment for a resource. Uses AI models to generate custom columns. |
instantly.instantly_create_api_key | Write write | 2 | Create a new API key with specified scopes. |
instantly.instantly_create_blocklist_entry | Write write | 1 | Add an email or domain to the blocklist. |
instantly.instantly_create_campaign | Write write | 11 | Create a new campaign with full configuration including sequences, schedule, and sender accounts. |
instantly.instantly_create_campaign_from_export | Write write | 1 | Create a new campaign from a shared/exported campaign ID. |
instantly.instantly_create_custom_prompt_template | Write write | 8 | Create a new custom prompt template for AI enrichment. |
instantly.instantly_create_custom_tag | Write write | 2 | Create a new custom tag for organizing accounts and campaigns. |
instantly.instantly_create_dfy_order | Write write | 3 | Place a DFY email account order. |
instantly.instantly_create_email_template | Write write | 4 | Create an email template. |
instantly.instantly_create_enrichment | Write write | 5 | Create an enrichment for a resource (campaign or lead list). |
instantly.instantly_create_inbox_placement_test | Write write | 6 | Create an inbox placement test. Send test emails to check deliverability. |
instantly.instantly_create_lead | Write write | 8 | Create a single lead. |
instantly.instantly_create_lead_label | Write write | 4 | Create a new lead label (custom interest status). |
instantly.instantly_create_lead_list | Write write | 1 | Create a new lead list. |
instantly.instantly_create_sales_flow | Write write | 1 | Create a sales flow. |
instantly.instantly_create_subsequence | Write write | 5 | Create a new subsequence for a campaign. |
instantly.instantly_create_webhook | Write write | 4 | Create a new webhook subscription. |
instantly.instantly_create_whitelabel | Write write | 1 | Set the agency domain (whitelabel) for the workspace. |
instantly.instantly_create_workspace_group_member | Write write | 1 | Create or invite a workspace group member. |
instantly.instantly_create_workspace_member | Write write | 2 | Invite a new member to the workspace. |
instantly.instantly_ctd_status | Read read | 1 | Get custom tracking domain (CTD) status. Check SSL and CNAME configuration. |
instantly.instantly_delete_account | Write write | 1 | Delete an email account by ID. |
instantly.instantly_delete_all_blocklist_entries | Write write | 3 | Delete all block list entries matching optional filters. Requires confirm=true. |
instantly.instantly_delete_api_key | Write write | 1 | Delete an API key by ID. |
instantly.instantly_delete_blocklist_entry | Write write | 1 | Remove an entry from the blocklist. |
instantly.instantly_delete_campaign | Write write | 1 | Delete a campaign by ID. |
instantly.instantly_delete_custom_prompt_template | Write write | 1 | Delete a custom prompt template. |
instantly.instantly_delete_custom_tag | Write write | 1 | Delete a custom tag by ID. |
instantly.instantly_delete_email | Write write | 1 | Delete an email. |
instantly.instantly_delete_email_template | Write write | 1 | Delete an email template. |
instantly.instantly_delete_inbox_placement_test | Write write | 1 | Delete an inbox placement test. |
instantly.instantly_delete_lead | Write write | 1 | Delete a lead by ID. |
instantly.instantly_delete_lead_label | Write write | 2 | Delete a lead label. |
instantly.instantly_delete_lead_list | Write write | 1 | Delete a lead list by ID. |
instantly.instantly_delete_phone_number | Write write | 1 | Delete a CRM phone number. |
instantly.instantly_delete_sales_flow | Write write | 1 | Delete a sales flow. |
instantly.instantly_delete_subsequence | Write write | 1 | Delete a subsequence by ID. |
instantly.instantly_delete_webhook | Write write | 1 | Delete a webhook by ID. |
instantly.instantly_delete_whitelabel | Write write | 0 | Delete the whitelabel domain. |
instantly.instantly_delete_workspace_group_member | Write write | 1 | Delete a workspace group member. |
instantly.instantly_delete_workspace_member | Write write | 1 | Remove a member from the workspace. |
instantly.instantly_deliverability_insights | Read read | 9 | Get deliverability insights for an inbox placement test. |
instantly.instantly_download_blocklist_entries | Read read | 2 | Download block list entries as CSV text. |
instantly.instantly_duplicate_campaign | Write write | 2 | Duplicate a campaign. |
instantly.instantly_duplicate_subsequence | Write write | 3 | Duplicate a subsequence to the same or different campaign. |
instantly.instantly_email_unread_count | Read read | 0 | Get the count of unread emails. |
instantly.instantly_email_verification_status | Read read | 1 | Get email verification status for an address. |
instantly.instantly_enrichment_count_leads | Read read | 1 | Count leads matching SuperSearch filters without importing them. |
instantly.instantly_enrichment_enrich_leads | Read read | 2 | Enrich leads from SuperSearch. Import and enrich leads matching your search filters. |
instantly.instantly_enrichment_history | Read read | 1 | Retrieve enrichment history for a resource. |
instantly.instantly_enrichment_preview_leads | Read read | 1 | Preview leads matching SuperSearch filters without importing. |
instantly.instantly_export_campaign | Read read | 1 | Export a campaign to JSON format. |
instantly.instantly_forward_email | Write write | 4 | Forward an email. |
instantly.instantly_get_account | Read read | 1 | Get an email account by ID with full details including warmup status, sending limits, and vitals. |
instantly.instantly_get_account_mappings | Read read | 3 | Get campaigns associated with an email account. |
instantly.instantly_get_background_job | Read read | 2 | Get a background job by ID. |
instantly.instantly_get_blocklist_entry | Read read | 1 | Get a blocklist entry by ID. |
instantly.instantly_get_campaign | Read read | 1 | Get a campaign by ID with full details. |
instantly.instantly_get_custom_prompt_template | Read read | 1 | Get a custom prompt template by ID. |
instantly.instantly_get_custom_tag | Read read | 1 | Get a custom tag by ID. |
instantly.instantly_get_email | Read read | 1 | Get an email by ID. |
instantly.instantly_get_email_template | Read read | 1 | Get an email template by ID. |
instantly.instantly_get_enrichment | Read read | 1 | Get enrichment settings for a resource (campaign or lead list). |
instantly.instantly_get_inbox_placement_analytics | Read read | 1 | Get a single inbox placement analytics entry. |
instantly.instantly_get_inbox_placement_report | Read read | 1 | Get an inbox placement report by ID. |
instantly.instantly_get_inbox_placement_test | Read read | 2 | Get an inbox placement test by ID. |
instantly.instantly_get_lead | Read read | 1 | Get a lead by ID. |
instantly.instantly_get_lead_label | Read read | 1 | Get a lead label by ID. |
instantly.instantly_get_lead_list | Read read | 1 | Get a lead list by ID. |
instantly.instantly_get_oauth_session_status | Read read | 1 | Get the status of a Google or Microsoft OAuth account connection session. |
instantly.instantly_get_sales_flow | Read read | 1 | Get a sales flow by ID. |
instantly.instantly_get_webhook | Read read | 1 | Get a webhook by ID. |
instantly.instantly_get_webhook_event | Read read | 1 | Get a webhook event by ID. |
instantly.instantly_get_whitelabel | Read read | 0 | Get whitelabel domain information. |
instantly.instantly_get_workspace | Read read | 0 | Get current workspace details based on your API key. |
instantly.instantly_get_workspace_group_member | Read read | 1 | Get a workspace group member by ID. |
instantly.instantly_get_workspace_group_members_admin | Read read | 0 | Get admin workspace group members. |
instantly.instantly_get_workspace_member | Read read | 1 | Get a workspace member by ID. |
instantly.instantly_inbox_placement_esp_options | Read read | 0 | Get available email service provider options for inbox placement tests. |
instantly.instantly_inbox_placement_stats_by_date | Read read | 7 | Get time series stats for inbox placement (inbox/spam/category distribution). |
instantly.instantly_inbox_placement_stats_by_test | Read read | 7 | Get aggregated inbox/spam/category counts for test IDs. |
instantly.instantly_initialize_google_oauth | Read read | 0 | Initialize a Google OAuth account connection flow and return the authorization URL. |
instantly.instantly_initialize_microsoft_oauth | Read read | 0 | Initialize a Microsoft OAuth account connection flow and return the authorization URL. |
instantly.instantly_lead_list_verification_stats | Read read | 1 | Get email verification statistics for a lead list. |
instantly.instantly_list_accounts | Read read | 4 | List all email accounts in the workspace. Returns email, status, warmup status, and sending limits. |
instantly.instantly_list_api_keys | Read read | 2 | List all API keys in the workspace. |
instantly.instantly_list_audit_logs | Read read | 6 | List audit log records for tracking workspace activities. |
instantly.instantly_list_background_jobs | Read read | 9 | List background jobs. Track long-running tasks like bulk imports and exports. |
instantly.instantly_list_blocklist | Read read | 4 | List all blocklist entries (blocked emails and domains). |
instantly.instantly_list_campaigns | Read read | 4 | List all campaigns in the workspace. |
instantly.instantly_list_custom_prompt_templates | Read read | 3 | List custom prompt templates. |
instantly.instantly_list_custom_tag_mappings | Read read | 3 | List custom tag mappings showing which tags are on which resources. |
instantly.instantly_list_custom_tags | Read read | 5 | List custom tags used to organize accounts and campaigns. |
instantly.instantly_list_dfy_accounts | Read read | 3 | List DFY ordered email accounts. |
instantly.instantly_list_dfy_orders | Read read | 2 | List DFY email account orders. |
instantly.instantly_list_email_templates | Read read | 3 | List email templates. |
instantly.instantly_list_emails | Read read | 7 | List emails from the Unibox (unified inbox). |
instantly.instantly_list_inbox_placement_analytics | Read read | 8 | List inbox placement analytics for a test. |
instantly.instantly_list_inbox_placement_reports | Read read | 7 | List inbox placement blacklist and SpamAssassin reports. |
instantly.instantly_list_inbox_placement_tests | Read read | 5 | List inbox placement tests. |
instantly.instantly_list_lead_labels | Read read | 2 | List all lead labels (interest statuses) in the workspace. |
instantly.instantly_list_lead_lists | Read read | 3 | List all lead lists in the workspace. |
instantly.instantly_list_leads | Read read | 5 | List leads in a campaign or list. |
instantly.instantly_list_phone_numbers | Read read | 2 | List CRM phone numbers. |
instantly.instantly_list_sales_flows | Read read | 2 | List sales flows. |
instantly.instantly_list_subsequences | Read read | 4 | List all subsequences for a campaign. |
instantly.instantly_list_webhook_events | Read read | 6 | List webhook events. |
instantly.instantly_list_webhooks | Read read | 4 | List all webhooks in the workspace. |
instantly.instantly_list_workspace_group_members | Read read | 2 | List workspace group members. |
instantly.instantly_list_workspace_members | Read read | 0 | List all workspace members. |
instantly.instantly_mark_account_fixed | Write write | 1 | Mark an email account as fixed after resolving connection or sending errors. |
instantly.instantly_mark_email_read | Write write | 1 | Mark an email thread as read. |
instantly.instantly_merge_leads | Write write | 2 | Merge two leads into one. |
instantly.instantly_move_accounts | Write write | 3 | Move email accounts between workspaces. Requires an admin workspace API key. |
instantly.instantly_move_leads | Write write | 3 | Move leads between campaigns. |
instantly.instantly_pause_account | Write write | 1 | Pause an email account. Stops sending until resumed. |
instantly.instantly_pause_campaign | Write write | 1 | Pause a running campaign. |
instantly.instantly_pause_subsequence | Write write | 1 | Pause a subsequence. |
instantly.instantly_pre_warmed_domains | Read read | 2 | Get pre-warmed up domains available for order. |
instantly.instantly_remove_from_subsequence | Write write | 1 | Remove a lead from a subsequence. |
instantly.instantly_reply_to_email | Write write | 4 | Reply to an email thread. |
instantly.instantly_resume_account | Write write | 1 | Resume a paused email account. |
instantly.instantly_resume_subsequence | Write write | 1 | Resume a paused subsequence. |
instantly.instantly_resume_webhook | Write write | 1 | Resume a disabled webhook. |
instantly.instantly_run_enrichment | Write write | 2 | Run enrichment for a campaign or lead list. |
instantly.instantly_search_campaigns_by_contact | Read read | 3 | Find campaigns containing a specific lead email. |
instantly.instantly_send_test_email | Write write | 5 | Send a preview/test email from a connected email account without creating an Unibox email. |
instantly.instantly_share_campaign | Read read | 1 | Share a campaign so other users can create a new campaign from it. |
instantly.instantly_similar_domains | Read read | 1 | Get similar domains for DFY orders. |
instantly.instantly_subsequence_move_leads | Write write | 2 | Move leads to a subsequence. |
instantly.instantly_subsequence_sending_status | Read read | 2 | Get the sending status of a subsequence. |
instantly.instantly_test_ai_label | Write write | 1 | Test AI reply label prediction. Returns predicted label for a given reply text. |
instantly.instantly_test_vitals | Write write | 2 | Test account vitals (DNS, SMTP, IMAP connectivity). Returns diagnostic results. |
instantly.instantly_test_webhook | Write write | 1 | Send a test payload to a webhook. |
instantly.instantly_toggle_custom_tags | Write write | 4 | Assign or unassign tags to resources (accounts or campaigns). |
instantly.instantly_update_account | Write write | 9 | Update an email account. Modify daily limit, tracking domain, signature, and more. |
instantly.instantly_update_blocklist_entry | Write write | 2 | Update a blocklist entry. |
instantly.instantly_update_campaign | Write write | 11 | Update an existing campaign configuration. |
instantly.instantly_update_custom_prompt_template | Write write | 9 | Update a custom prompt template. |
instantly.instantly_update_custom_tag | Write write | 3 | Update a custom tag. |
instantly.instantly_update_email | Write write | 3 | Update an email (e.g., assign to a team member, update label). |
instantly.instantly_update_email_template | Write write | 5 | Update an email template. |
instantly.instantly_update_enrichment_settings | Write write | 3 | Update enrichment settings for a resource. |
instantly.instantly_update_inbox_placement_test | Write write | 3 | Update an inbox placement test. |
instantly.instantly_update_lead | Write write | 10 | Update a lead. |
instantly.instantly_update_lead_interest_status | Write write | 6 | Update a lead interest status by lead email, optionally scoped to a campaign or list. |
instantly.instantly_update_lead_label | Write write | 5 | Update a lead label. |
instantly.instantly_update_lead_list | Write write | 2 | Update a lead list name. |
instantly.instantly_update_sales_flow | Write write | 2 | Update a sales flow. |
instantly.instantly_update_subsequence | Write write | 2 | Update a subsequence. |
instantly.instantly_update_webhook | Write write | 6 | Update a webhook. |
instantly.instantly_update_workspace | Write write | 2 | Update current workspace name or logo. |
instantly.instantly_update_workspace_member | Write write | 2 | Update a workspace member role. |
instantly.instantly_verify_email | Write write | 2 | Verify an email address. Returns deliverability status. |
instantly.instantly_warmup_disable | Write write | 1 | Disable warmup for email accounts. |
instantly.instantly_warmup_enable | Write write | 1 | Enable warmup for email accounts. Gradually increases sending volume to build reputation. |
instantly.instantly_webhook_event_types | Read read | 0 | List all available webhook event types. |
instantly.instantly_webhook_events_summary | Read read | 2 | Get overview aggregates for webhook events. |
instantly.instantly_webhook_events_summary_by_date | Read read | 2 | Get webhook event aggregates grouped by date. |