productivity
Instantly CLI for Headless Automation
Use the Instantly CLI for headless automation with headless JSON commands, schema discovery, credentials, and permission controls.
181 functions 87 read 94 write API key auth
Instantly CLI for Headless Automation
Use KosmoKrator as a non-interactive integration runtime for local automations and wrappers.
Use headless automation when another tool needs a stable local command surface. The Instantly CLI uses the same integration registry as the TUI, Lua runtime, and MCP gateway, but returns predictable command output for automation.
Command Shape
# Instantly CLI for Headless Automation
kosmokrator integrations:configure instantly --set api_key="$INSTANTLY_API_KEY" --enable --read allow --write ask --json
kosmo integrations:call instantly.instantly_activate_campaign '{"id":"example_id"}' --json Discovery Before Execution
Agents and scripts can inspect Instantly docs and schemas before choosing a function.
kosmo integrations:docs instantly --json
kosmo integrations:docs instantly.instantly_activate_campaign --json
kosmo integrations:schema instantly.instantly_activate_campaign --json
kosmo integrations:search "Instantly" --json
kosmo integrations:list --json Useful Instantly CLI Functions
| Function | Type | Parameters | Description |
|---|---|---|---|
instantly.instantly_activate_campaign | Write | id | Activate a campaign to start sending emails. |
instantly.instantly_add_campaign_variables | Write | id, variables | Add custom variables to an existing campaign. |
instantly.instantly_ai_enrichment_progress | Read | resource_id | Get AI enrichment progress for a resource. |
instantly.instantly_analytics_campaign | Read | campaign_id, from, to | Get campaign analytics including sends, opens, clicks, replies, and bounces. |
instantly.instantly_analytics_campaign_overview | Read | from, to | Get overview analytics across all campaigns. |
instantly.instantly_analytics_campaign_steps | Read | campaign_id, from, to | Get campaign step analytics. |
instantly.instantly_analytics_daily_account | Read | from, to | Get daily account analytics breakdown. |
instantly.instantly_analytics_daily_campaign | Read | campaign_id, from, to | Get daily campaign analytics breakdown. |
instantly.instantly_analytics_warmup | Read | emails | Get warmup analytics for email accounts. |
instantly.instantly_billing_plan_details | Read | none | Get workspace plan details. |
instantly.instantly_billing_subscription_details | Read | none | Get workspace subscription details. |
instantly.instantly_bulk_add_leads | Write | leads, campaign_id, list_id, skip_if_in_workspace, skip_if_in_campaign | Add leads in bulk to a campaign or list. |
instantly.instantly_bulk_assign_leads | Write | organization_user_ids, campaign, list_id, ids, limit | Bulk assign leads to organization users. |
instantly.instantly_bulk_create_blocklist_entries | Write | bl_values | Create block list entries in bulk from domains or email addresses. |
instantly.instantly_bulk_delete_blocklist_entries | Write | ids | Delete block list entries in bulk by entry ID. |
instantly.instantly_bulk_delete_leads | Write | campaign_id, list_id, ids, status, limit | Delete multiple leads in bulk. |
instantly.instantly_campaign_sending_status | Read | id, with_ai_summary | Get sending status and diagnostics for a campaign. |
instantly.instantly_cancel_dfy_accounts | Write | accounts | Cancel DFY email accounts. |
instantly.instantly_change_workspace_owner | Write | email, sec | Change the owner of the current workspace. |
instantly.instantly_check_dfy_domains | Read | domains | Check domain availability for DFY orders. |
instantly.instantly_count_launched_campaigns | Read | none | Get the count of launched campaigns. |
instantly.instantly_create_account | Write | email, first_name, last_name, smtp_host, smtp_port, smtp_username, smtp_password, imap_host, imap_port, imap_username, imap_password, daily_limit | Create a new email account via SMTP/IMAP credentials. |
instantly.instantly_create_ai_enrichment | Write | resource_id, output_column, resource_type, model_version, input_columns, use_instantly_account, overwrite, auto_update, skip_leads_without_email, limit, prompt, template_id | Create AI enrichment for a resource. Uses AI models to generate custom columns. |
instantly.instantly_create_api_key | Write | name, scopes | Create a new API key with specified scopes. |
instantly.instantly_create_blocklist_entry | Write | bl_value | Add an email or domain to the blocklist. |
instantly.instantly_create_campaign | Write | name, open_tracking, link_tracking, text_only, stop_on_reply, stop_on_auto_reply, daily_limit, email_gap, email_list, sequences, campaign_schedule | Create a new campaign with full configuration including sequences, schedule, and sender accounts. |
instantly.instantly_create_campaign_from_export | Write | id | Create a new campaign from a shared/exported campaign ID. |
instantly.instantly_create_custom_prompt_template | Write | name, prompt, category, is_public, description, model_version, template_type, from_shared | Create a new custom prompt template for AI enrichment. |
instantly.instantly_create_custom_tag | Write | label, description | Create a new custom tag for organizing accounts and campaigns. |
instantly.instantly_create_dfy_order | Write | items, order_type, simulation | Place a DFY email account order. |
instantly.instantly_create_email_template | Write | template_name, subject, body, category | Create an email template. |
instantly.instantly_create_enrichment | Write | resource_id, type, limit, filters, custom_flow | Create an enrichment for a resource (campaign or lead list). |
instantly.instantly_create_inbox_placement_test | Write | name, type, sending_method, email_subject, email_body, emails | Create an inbox placement test. Send test emails to check deliverability. |
instantly.instantly_create_lead | Write | email, campaign_id, list_id, first_name, last_name, company_name, website, phone | Create a single lead. |
instantly.instantly_create_lead_label | Write | label_name, color, icon, value | Create a new lead label (custom interest status). |
instantly.instantly_create_lead_list | Write | name | Create a new lead list. |
instantly.instantly_create_sales_flow | Write | body | Create a sales flow. |
instantly.instantly_create_subsequence | Write | parent_campaign, name, conditions, subsequence_schedule, sequences | Create a new subsequence for a campaign. |
instantly.instantly_create_webhook | Write | target_hook_url, event_type, campaign, name | Create a new webhook subscription. |
instantly.instantly_create_whitelabel | Write | domain | Set the agency domain (whitelabel) for the workspace. |
Showing 40 of 181 functions. See the Instantly CLI reference for every function.
Automation Notes
- Use
--jsonfor machine-readable output. - Keep credentials out of argv by using environment variables or stored KosmoKrator configuration.
- Configure read/write policy before unattended runs; use
--forceonly for trusted automation. - Use the MCP gateway instead when the agent needs dynamic tool discovery inside a conversation.