instantly-outreach · diff
v2.0.2 to v2.0.2
1 added, 1 removed, first 3,000 lines shown. Audit A to A.
---
name: instantly-outreach
description: "Manage cold email campaigns, leads, and outreach analytics via Instantly AI through the superagnt unified API."
version: 2.0.2
author: superagnt
license: MIT-0
platforms: [macos, linux, windows]
required_environment_variables:
- SUPERAGNT_API_KEY
metadata:
hermes:
tags: [instantly, integration, api, ai-agent]
openclaw:
requires:
env:
- SUPERAGNT_API_KEY
bins:
- curl
primaryEnv: SUPERAGNT_API_KEY
emoji: "📧"
homepage: https://superagnt.com/r/ch-instantly-outreach-docs
---
# Instantly AI Integration
The Instantly AI integration connects your Instantly account to superagnt, enabling AI agents and workflows to manage cold email campaigns, leads, analytics, and account settings programmatically. Supports campaign CRUD, lead management, sending accounts, warmup settings, and detailed analytics.
## Alternative install: the MCP server
If this client speaks MCP, you can connect the workspace server instead of
using this skill's curl calls — after the user connects their
Instantly AI account in the superagnt app, the same endpoints below are exposed
as native MCP tools:
```
https://mcp.superagnt.com/mcp
```
The URL publishes full OAuth discovery — an MCP-capable client needs the URL
and nothing else (approve once in the browser). Per-client setup lines:
- https://mcp.superagnt.com/agent-setup/prompt.md
+ https://www.superagnt.com/install
Everything below works on curl-only environments with just the API key.
## Capabilities and safety
This skill documents the Instantly AI API surface the user's connected
account can reach — which can include destructive operations (updates,
deletes) and, where the vendor supports them, actions performed as the user
(sending messages, modifying records, changing settings). Two hard rules:
- **Confirm before destructive or outbound actions.** Never delete, overwrite,
or send on the user's behalf without their explicit confirmation in the
conversation.
- **Stay inside the user's request.** Use only the endpoints the task needs;
this skill grants no access beyond the Instantly AI connection the user
set up themselves.
**Disclosure:** Account administration: beyond outreach, the Instantly API includes workspace administration, billing, API-key, and account-procurement endpoints. Use those only when the user explicitly asks for account administration, and always confirm before creating keys, changing billing, or purchasing anything.
## Prerequisites
1. An API key — get one from the [superagnt app](https://superagnt.com/r/ch-instantly-outreach-key) and export it as
`SUPERAGNT_API_KEY`.
2. A connected Instantly AI account — connect it on the
[Connections page](https://app.superagnt.com/dashboard/connections). Calls fail with a clear error
until the vendor is connected; that error is the signal to send the user to
the connections page, not a bug.
Note: `/v1/connections/*` calls run on the USER'S Instantly AI credentials —
vendor-side rate limits and billing are theirs, not platform credits.
## Authentication
```
Authorization: Bearer $SUPERAGNT_API_KEY
```
If the variable is not set, ask the user for their key or point them at
https://superagnt.com/r/ch-instantly-outreach-key.
## Verify the install (do this first)
```bash
curl -s https://api.superagnt.com/v1/credits \
-H 'Authorization: Bearer $SUPERAGNT_API_KEY'
```
A JSON result proves the key end to end. 401 = bad key; an error naming the
connection means the Instantly AI account is not connected yet.
## Base URL
```
https://api.superagnt.com/v1/connections/instantly
```
## Available Endpoints
| Method | Path | Summary |
|--------|------|---------|
| `GET` | `/api/v2/account-campaign-mappings/{email}` | Get campaigns associated with an email |
| `GET` | `/api/v2/accounts` | List account |
| `POST` | `/api/v2/accounts` | Create account |
| `GET` | `/api/v2/accounts/{email}` | Get account |
| `PATCH` | `/api/v2/accounts/{email}` | Patch account |
| `DELETE` | `/api/v2/accounts/{email}` | Delete account |
| `POST` | `/api/v2/accounts/warmup/enable` | Enable warmup for accounts |
| `POST` | `/api/v2/accounts/warmup/disable` | Disable warmup for accounts |
| `POST` | `/api/v2/accounts/warmup-analytics` | Get warmup analytics |
| `GET` | `/api/v2/accounts/analytics/daily` | Get daily account analytics |
| `POST` | `/api/v2/accounts/{email}/pause` | Pause an account |
| `POST` | `/api/v2/accounts/{email}/resume` | Resume a paused account |
| `POST` | `/api/v2/accounts/{email}/mark-fixed` | Mark an account as fixed |
| `GET` | `/api/v2/accounts/ctd/status` | Get custom tracking domain status |
| `POST` | `/api/v2/accounts/test/vitals` | Test account vitals |
| `POST` | `/api/v2/accounts/move` | Move accounts between workspaces |
| `GET` | `/api/v2/api-keys` | List api key |
| `POST` | `/api/v2/api-keys` | Create api key |
| `DELETE` | `/api/v2/api-keys/{id}` | Delete api key |
| `GET` | `/api/v2/audit-logs` | List audit log |
| `GET` | `/api/v2/background-jobs` | List background job |
| `GET` | `/api/v2/background-jobs/{id}` | Get background job |
| `GET` | `/api/v2/block-lists-entries` | List block list entry |
| `POST` | `/api/v2/block-lists-entries` | Create block list entry |
| `DELETE` | `/api/v2/block-lists-entries` | Delete all block list entries |
| `GET` | `/api/v2/block-lists-entries/{id}` | Get block list entry |
| `PATCH` | `/api/v2/block-lists-entries/{id}` | Patch block list entry |
| `DELETE` | `/api/v2/block-lists-entries/{id}` | Delete block list entry |
| `POST` | `/api/v2/block-lists-entries/bulk-create` | Bulk create block list entry |
| `POST` | `/api/v2/block-lists-entries/bulk-delete` | Bulk delete block list entry |
| `GET` | `/api/v2/block-lists-entries/download` | Download all block list entries as CSV |
| `GET` | `/api/v2/campaigns` | List campaign |
| `POST` | `/api/v2/campaigns` | Create campaign |
| `POST` | `/api/v2/campaigns/{id}/activate` | Activate(start), or resume a campaign |
| `POST` | `/api/v2/campaigns/{id}/pause` | Stop(or pause) a campaign |
| `GET` | `/api/v2/campaigns/{id}` | Get campaign |
| `PATCH` | `/api/v2/campaigns/{id}` | Patch campaign |
| `DELETE` | `/api/v2/campaigns/{id}` | Delete campaign |
| `GET` | `/api/v2/campaigns/search-by-contact` | Search campaigns by lead email |
| `GET` | `/api/v2/campaigns/analytics` | Get campaign(s) analytics |
| `GET` | `/api/v2/campaigns/analytics/overview` | Get campaign(s) analytics overview |
| `GET` | `/api/v2/campaigns/analytics/daily` | Get daily campaign analytics |
| `GET` | `/api/v2/campaigns/analytics/steps` | Get campaign steps analytics |
| `POST` | `/api/v2/campaigns/{id}/share` | Share a campaign |
| `POST` | `/api/v2/campaigns/{id}/from-export` | Create campaign from shared one |
| `POST` | `/api/v2/campaigns/{id}/export` | Export campaign to JSON format |
| `POST` | `/api/v2/campaigns/{id}/duplicate` | Duplicate campaign |
| `GET` | `/api/v2/campaigns/count-launched` | Get launched campaigns count |
| `POST` | `/api/v2/campaigns/{id}/variables` | Add campaign variables |
| `GET` | `/api/v2/campaigns/{id}/sending-status` | Get campaign sending status |
| `GET` | `/api/v2/crm-actions/phone-numbers` | List phone numbers |
| `DELETE` | `/api/v2/crm-actions/phone-numbers/{id}` | Delete phone number |
| `GET` | `/api/v2/custom-tag-mappings` | List custom tag mapping |
| `GET` | `/api/v2/custom-tags` | List custom tag |
| `POST` | `/api/v2/custom-tags` | Create custom tag |
| `GET` | `/api/v2/custom-tags/{id}` | Get custom tag |
| `PATCH` | `/api/v2/custom-tags/{id}` | Patch custom tag |
| `DELETE` | `/api/v2/custom-tags/{id}` | Delete custom tag |
| `POST` | `/api/v2/custom-tags/toggle-resource` | Assign or unassign tags to resources |
| `GET` | `/api/v2/dfy-email-account-orders` | List dfy email account order |
| `POST` | `/api/v2/dfy-email-account-orders` | Place a DFY email account order |
| `POST` | `/api/v2/dfy-email-account-orders/domains/similar` | Generate similar available domains |
| `POST` | `/api/v2/dfy-email-account-orders/domains/check` | Check domains availability |
| `POST` | `/api/v2/dfy-email-account-orders/domains/pre-warmed-up-list` | Get pre-warmed up domains |
| `GET` | `/api/v2/dfy-email-account-orders/accounts` | List DFY ordered email accounts |
| `POST` | `/api/v2/dfy-email-account-orders/accounts/cancel` | Cancel dfy email accounts |
| `POST` | `/api/v2/emails/test` | Send a test email |
| `POST` | `/api/v2/emails/reply` | Reply to an email |
| `POST` | `/api/v2/emails/forward` | Forward an email |
| `GET` | `/api/v2/emails` | List email |
| `GET` | `/api/v2/emails/{id}` | Get email |
| `PATCH` | `/api/v2/emails/{id}` | Patch email |
| `DELETE` | `/api/v2/emails/{id}` | Delete email |
| `GET` | `/api/v2/emails/unread/count` | Count unread emails |
| `POST` | `/api/v2/emails/threads/{thread_id}/mark-as-read` | Mark all emails in a thread as read |
| `GET` | `/api/v2/inbox-placement-analytics` | List inbox placement analytics |
| `GET` | `/api/v2/inbox-placement-analytics/{id}` | Get inbox placement analytics |
| `POST` | `/api/v2/inbox-placement-analytics/stats-by-test-id` | Retrieve inbox placement analytics stats by test id |
| `POST` | `/api/v2/inbox-placement-analytics/deliverability-insights` | Retrieve inbox placement analytics deliverability insights |
| `POST` | `/api/v2/inbox-placement-analytics/stats-by-date` | Get inbox placement analytics stats by date |
| `GET` | `/api/v2/inbox-placement-reports` | List inbox placement blacklist & spamassassin report |
| `GET` | `/api/v2/inbox-placement-reports/{id}` | Get inbox placement blacklist & spamassassin report |
| `GET` | `/api/v2/inbox-placement-tests` | List inbox placement test |
| `POST` | `/api/v2/inbox-placement-tests` | Create inbox placement test |
| `GET` | `/api/v2/inbox-placement-tests/{id}` | Get inbox placement test |
| `PATCH` | `/api/v2/inbox-placement-tests/{id}` | Patch inbox placement test |
| `DELETE` | `/api/v2/inbox-placement-tests/{id}` | Delete inbox placement test |
| `GET` | `/api/v2/inbox-placement-tests/email-service-provider-options` | Get ESP options |
| `GET` | `/api/v2/lead-labels` | List lead label |
| `POST` | `/api/v2/lead-labels` | Create lead label |
| `GET` | `/api/v2/lead-labels/{id}` | Get lead label |
| `PATCH` | `/api/v2/lead-labels/{id}` | Patch lead label |
| `DELETE` | `/api/v2/lead-labels/{id}` | Delete lead label |
| `POST` | `/api/v2/lead-labels/ai-reply-label` | Test AI reply label prediction |
| `GET` | `/api/v2/lead-lists` | List lead list |
| `POST` | `/api/v2/lead-lists` | Create lead list |
| `GET` | `/api/v2/lead-lists/{id}` | Get lead list |
| `PATCH` | `/api/v2/lead-lists/{id}` | Patch lead list |
| `DELETE` | `/api/v2/lead-lists/{id}` | Delete lead list |
| `GET` | `/api/v2/lead-lists/{id}/verification-stats` | Get verification statistics for a lead list |
| `POST` | `/api/v2/leads` | Create lead |
| `DELETE` | `/api/v2/leads` | Delete leads in bulk |
| `POST` | `/api/v2/leads/list` | List leads |
| `GET` | `/api/v2/leads/{id}` | Get lead |
| `PATCH` | `/api/v2/leads/{id}` | Patch lead |
| `DELETE` | `/api/v2/leads/{id}` | Delete lead |
| `POST` | `/api/v2/leads/merge` | Merge two leads |
| `POST` | `/api/v2/leads/update-interest-status` | Update the interest status of a lead |
| `POST` | `/api/v2/leads/subsequence/remove` | Remove a lead from a subsequence |
| `POST` | `/api/v2/leads/bulk-assign` | Bulk assign leads to organization users |
| `POST` | `/api/v2/leads/move` | Move leads to a campaign or list |
| `POST` | `/api/v2/leads/subsequence/move` | Move a lead to a subsequence |
| `POST` | `/api/v2/leads/add` | Add leads in bulk to a campaign or list |
| `POST` | `/api/v2/oauth/google/init` | Initialize google oauth |
| `POST` | `/api/v2/oauth/microsoft/init` | Initialize microsoft oauth |
| `GET` | `/api/v2/oauth/session/status/{sessionId}` | Get oauth session status |
| `GET` | `/api/v2/subsequences` | List campaign subsequence |
| `POST` | `/api/v2/subsequences` | Create campaign subsequence |
| `POST` | `/api/v2/subsequences/{id}/duplicate` | Duplicate a subsequence |
| `POST` | `/api/v2/subsequences/{id}/pause` | Pause a subsequence |
| `POST` | `/api/v2/subsequences/{id}/resume` | Resume a paused subsequence |
| `GET` | `/api/v2/subsequences/{id}` | Get campaign subsequence |
| `PATCH` | `/api/v2/subsequences/{id}` | Patch campaign subsequence |
| `DELETE` | `/api/v2/subsequences/{id}` | Delete campaign subsequence |
| `GET` | `/api/v2/subsequences/{id}/sending-status` | Get subsequence sending status |
| `POST` | `/api/v2/supersearch-enrichment/enrich-leads-from-supersearch` | Enrich leads from supersearch |
| `GET` | `/api/v2/supersearch-enrichment/{resource_id}` | Get enrichment for resource |
| `POST` | `/api/v2/supersearch-enrichment` | Create an enrichment |
| `PATCH` | `/api/v2/supersearch-enrichment/{resource_id}/settings` | Update enrichment settings for resource |
| `POST` | `/api/v2/supersearch-enrichment/ai` | Create AI enrichment |
| `GET` | `/api/v2/supersearch-enrichment/ai/{resource_id}/in-progress` | Get AI enrichment for resource |
| `GET` | `/api/v2/supersearch-enrichment/history/{resource_id}` | Get enrichment history |
| `POST` | `/api/v2/supersearch-enrichment/run` | Run enrichment for resource |
| `POST` | `/api/v2/supersearch-enrichment/count-leads-from-supersearch` | Count leads from supersearch |
| `POST` | `/api/v2/supersearch-enrichment/preview-leads-from-supersearch` | Preview leads from supersearch |
| `GET` | `/api/v2/webhook-events` | List webhook event |
| `GET` | `/api/v2/webhook-events/{id}` | Get webhook event |
| `GET` | `/api/v2/webhook-events/summary` | Get overview aggregates for webhook events |
| `GET` | `/api/v2/webhook-events/summary-by-date` | Get overview aggregates for webhook events by date |
| `GET` | `/api/v2/webhooks` | List webhooks |
| `POST` | `/api/v2/webhooks` | Create webhook |
| `GET` | `/api/v2/webhooks/{id}` | Get webhook |
| `PATCH` | `/api/v2/webhooks/{id}` | Patch webhook |
| `DELETE` | `/api/v2/webhooks/{id}` | Delete webhook |
| `GET` | `/api/v2/webhooks/event-types` | List available event types |
| `POST` | `/api/v2/webhooks/{id}/test` | Test a webhook |
| `POST` | `/api/v2/webhooks/{id}/resume` | Resume a webhook |
| `GET` | `/api/v2/workspace-billing/plan-details` | Get workspace plan details |
| `GET` | `/api/v2/workspace-billing/subscription-details` | Get workspace subscription details |
| `GET` | `/api/v2/workspace-group-members` | List workspace group member |
| `POST` | `/api/v2/workspace-group-members` | Create workspace group member |
| `GET` | `/api/v2/workspace-group-members/{id}` | Get workspace group member |
| `DELETE` | `/api/v2/workspace-group-members/{id}` | Delete workspace group member |
| `GET` | `/api/v2/workspace-group-members/admin` | Get the current workspace admin workspace |
| `GET` | `/api/v2/workspace-members` | List workspace member |
| `POST` | `/api/v2/workspace-members` | Create workspace member |
| `GET` | `/api/v2/workspace-members/{id}` | Get workspace member |
| `PATCH` | `/api/v2/workspace-members/{id}` | Patch workspace member |
| `DELETE` | `/api/v2/workspace-members/{id}` | Delete workspace member |
| `GET` | `/api/v2/workspaces/current` | Get workspace |
| `PATCH` | `/api/v2/workspaces/current` | Patch workspace |
| `GET` | `/api/v2/workspaces/current/whitelabel-domain` | Get organization verified agency domain information |
| `POST` | `/api/v2/workspaces/current/whitelabel-domain` | Set the agency domain for the workspace |
| `DELETE` | `/api/v2/workspaces/current/whitelabel-domain` | Delete organization agency domain |
| `POST` | `/api/v2/workspaces/current/change-owner` | Change workspace owner |
## Tool Schemas
The following JSON defines every operation with its parameters. Each tool maps
to an API endpoint under the base URL.
```json
[
{
"name": "superagnt_connection_instantly_getAccountCampaignMapping",
"description": "Get campaigns associated with an email",
"method": "GET",
"path": "/api/v2/account-campaign-mappings/{email}",
"parameters": {
"type": "object",
"properties": {
"limit": {
"type": "number",
"description": "limit"
},
"starting_after": {
"type": "string",
"description": "starting_after"
},
"email": {
"type": "string",
"description": "Email"
}
},
"required": [
"email"
]
}
},
{
"name": "superagnt_connection_instantly_listAccount",
"description": "List account",
"method": "GET",
"path": "/api/v2/accounts",
"parameters": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "The number of items to return"
},
"starting_after": {
"type": "string",
"description": "Pagination cursor from `next_starting_after`, in `timestamp_created&email` format. Legacy ISO date-time cursor is still supported."
},
"search": {
"type": "string",
"description": "search"
},
"status": {
"type": "number",
"description": "status"
},
"provider_code": {
"type": "number",
"description": "provider_code"
},
"tag_ids": {
"type": "string",
"description": "Filter accounts by tag ids. Returns accounts that have any of the specified tags assigned. You can specify multiple tag ids by separating them with a comma."
}
}
}
},
{
"name": "superagnt_connection_instantly_createAccount",
"description": "Create account",
"method": "POST",
"path": "/api/v2/accounts",
"parameters": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Email address of the account"
},
"first_name": {
"type": "string",
"description": "First name associated with the account"
},
"last_name": {
"type": "string",
"description": "Last name associated with the account"
},
"warmup": {
"type": "object",
"description": "Warmup configuration for the account"
},
"daily_limit": {
"type": [
"number",
"null"
],
"description": "Daily email sending limit"
},
"tracking_domain_name": {
"type": [
"string",
"null"
],
"description": "Tracking domain"
},
"tracking_domain_status": {
"type": [
"string",
"null"
],
"description": "Tracking domain status"
},
"enable_slow_ramp": {
"type": [
"boolean",
"null"
],
"description": "Whether to enable slow ramp up for sending limits"
},
"inbox_placement_test_limit": {
"type": [
"number",
"null"
],
"description": "The limit for inbox placement tests"
},
"provider_code": {
"type": "number",
"description": "Provider code for the account. Please make sure to specify the right provider code, otherwise your account will not work."
},
"sending_gap": {
"type": "number",
"description": "The gap between emails sent from this account in minutes (minimum wait time when used with multiple campaigns)"
},
"signature": {
"type": [
"string",
"null"
],
"description": "Email signature for the account"
},
"imap_username": {
"type": "string",
"description": "imap_username"
},
"imap_password": {
"type": "string",
"description": "imap_password"
},
"imap_host": {
"type": "string",
"description": "imap_host"
},
"imap_port": {
"type": "number",
"description": "imap_port"
},
"smtp_username": {
"type": "string",
"description": "smtp_username"
},
"smtp_password": {
"type": "string",
"description": "smtp_password"
},
"smtp_host": {
"type": "string",
"description": "smtp_host"
},
"smtp_port": {
"type": "number",
"description": "smtp_port"
},
"reply_to": {
"type": "string",
"description": "reply_to"
},
"warmup_custom_ftag": {
"type": "string",
"description": "warmup_custom_ftag"
},
"skip_cname_check": {
"type": "boolean",
"description": "skip_cname_check"
}
},
"required": [
"email",
"first_name",
"last_name",
"provider_code",
"imap_username",
"imap_password",
"imap_host",
"imap_port",
"smtp_username",
"smtp_password",
"smtp_host",
"smtp_port"
]
}
},
{
"name": "superagnt_connection_instantly_getAccount",
"description": "Get account",
"method": "GET",
"path": "/api/v2/accounts/{email}",
"parameters": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "The email of the account to get"
}
},
"required": [
"email"
]
}
},
{
"name": "superagnt_connection_instantly_patchAccount",
"description": "Patch account",
"method": "PATCH",
"path": "/api/v2/accounts/{email}",
"parameters": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "The email of the account to update"
},
"first_name": {
"type": "string",
"description": "First name associated with the account"
},
"last_name": {
"type": "string",
"description": "Last name associated with the account"
},
"warmup": {
"type": "object",
"description": "Warmup configuration for the account"
},
"daily_limit": {
"type": [
"number",
"null"
],
"description": "Daily email sending limit"
},
"tracking_domain_name": {
"type": [
"string",
"null"
],
"description": "Tracking domain"
},
"tracking_domain_status": {
"type": [
"string",
"null"
],
"description": "Tracking domain status"
},
"enable_slow_ramp": {
"type": [
"boolean",
"null"
],
"description": "Whether to enable slow ramp up for sending limits"
},
"inbox_placement_test_limit": {
"type": [
"number",
"null"
],
"description": "The limit for inbox placement tests"
},
"sending_gap": {
"type": "number",
"description": "The gap between emails sent from this account in minutes (minimum wait time when used with multiple campaigns)"
},
"signature": {
"type": [
"string",
"null"
],
"description": "Email signature for the account"
},
"skip_cname_check": {
"type": "boolean",
"description": "skip_cname_check"
},
"remove_tracking_domain": {
"type": "boolean",
"description": "remove_tracking_domain"
}
},
"required": [
"email"
]
}
},
{
"name": "superagnt_connection_instantly_deleteAccount",
"description": "Delete account",
"method": "DELETE",
"path": "/api/v2/accounts/{email}",
"parameters": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "The email of the account to get"
}
},
"required": [
"email"
]
}
},
{
"name": "superagnt_connection_instantly_enableWarmupForAccounts",
"description": "Enable warmup for accounts",
"method": "POST",
"path": "/api/v2/accounts/warmup/enable",
"parameters": {
"type": "object",
"properties": {
"emails": {
"type": "array",
"description": "List of emails to enable warmup accounts for. The emails should be attached to accounts in your workspace."
},
"include_all_emails": {
"type": "boolean",
"description": "If true, it will enable warmup to all accounts"
},
"excluded_emails": {
"type": "array",
"description": "List of emails to exclude when `include_all_emails` is `true`."
},
"filter": {
"type": [
"object",
"null"
],
"description": "Optional filter to apply when `include_all_emails` is `true`. Can contain tag_id or other filter criteria."
},
"search": {
"type": "string",
"description": "Optional search query to filter accounts when `include_all_emails` is `true`."
}
}
}
},
{
"name": "superagnt_connection_instantly_disableWarmupForAccounts",
"description": "Disable warmup for accounts",
"method": "POST",
"path": "/api/v2/accounts/warmup/disable",
"parameters": {
"type": "object",
"properties": {
"emails": {
"type": "array",
"description": "List of emails to disable warmup accounts for. The emails should be attached to accounts in your workspace."
},
"include_all_emails": {
"type": "boolean",
"description": "If true, it will disable warmup to all accounts"
},
"excluded_emails": {
"type": "array",
"description": "List of emails to exclude when `include_all_emails` is `true`."
},
"filter": {
"type": [
"object",
"null"
],
"description": "Optional filter to apply when `include_all_emails` is `true`. Can contain tag_id or other filter criteria."
},
"search": {
"type": "string",
"description": "Optional search query to filter accounts when `include_all_emails` is `true`."
}
}
}
},
{
"name": "superagnt_connection_instantly_getWarmupAnalytics",
"description": "Get warmup analytics",
"method": "POST",
"path": "/api/v2/accounts/warmup-analytics",
"parameters": {
"type": "object",
"properties": {
"emails": {
"type": "array",
"description": "List of emails to get warmup analytics for. The emails should be attached to accounts in your workspace."
}
},
"required": [
"emails"
]
}
},
{
"name": "superagnt_connection_instantly_getDailyAccountAnalytics",
"description": "Get daily account analytics",
"method": "GET",
"path": "/api/v2/accounts/analytics/daily",
"parameters": {
"type": "object",
"properties": {
"start_date": {
"type": "string",
"description": "Start date for the analytics period (optional). If not provided, returns data for the last 30 days."
},
"end_date": {
"type": "string",
"description": "End date for the analytics period (optional). If not provided, defaults to current date."
},
"emails": {
"type": "array",
"description": "Filter by specific email accounts (optional). If not provided, returns data for all accounts in your workspace."
}
}
}
},
{
"name": "superagnt_connection_instantly_pauseAccount",
"description": "Pause an account",
"method": "POST",
"path": "/api/v2/accounts/{email}/pause",
"parameters": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "The email of the account to pause"
}
},
"required": [
"email"
]
}
},
{
"name": "superagnt_connection_instantly_resumeAccount",
"description": "Resume a paused account",
"method": "POST",
"path": "/api/v2/accounts/{email}/resume",
"parameters": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Account email"
}
},
"required": [
"email"
]
}
},
{
"name": "superagnt_connection_instantly_markAccountFixed",
"description": "Mark an account as fixed",
"method": "POST",
"path": "/api/v2/accounts/{email}/mark-fixed",
"parameters": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Account email"
}
},
"required": [
"email"
]
}
},
{
"name": "superagnt_connection_instantly_getCtdStatus",
"description": "Get custom tracking domain status",
"method": "GET",
"path": "/api/v2/accounts/ctd/status",
"parameters": {
"type": "object",
"properties": {
"host": {
"type": "string",
"description": "Custom tracking domain host"
}
},
"required": [
"host"
]
}
},
{
"name": "superagnt_connection_instantly_testAccountVitals",
"description": "Test account vitals",
"method": "POST",
"path": "/api/v2/accounts/test/vitals",
"parameters": {
"type": "object",
"properties": {
"accounts": {
"type": "array",
"description": "accounts"
}
}
}
},
{
"name": "superagnt_connection_instantly_moveAccounts",
"description": "Move accounts between workspaces",
"method": "POST",
"path": "/api/v2/accounts/move",
"parameters": {
"type": "object",
"properties": {
"emails": {
"type": "array",
"description": "Array of email addresses of the accounts to move"
},
"source_workspace_id": {
"type": "string",
"description": "ID of the source workspace (the workspace that the accounts are currently in)"
},
"destination_workspace_id": {
"type": "string",
"description": "ID of the destination workspace (the workspace that the accounts will be moved to)"
}
},
"required": [
"emails",
"source_workspace_id",
"destination_workspace_id"
]
}
},
{
"name": "superagnt_connection_instantly_listAPIKey",
"description": "List api key",
"method": "GET",
"path": "/api/v2/api-keys",
"parameters": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "The number of items to return"
},
"starting_after": {
"type": "string",
"description": "The ID of the last item in the previous page - used for pagination. You can use the value of the `next_starting_after` field from the previous response."
}
}
}
},
{
"name": "superagnt_connection_instantly_createAPIKey",
"description": "Create api key",
"method": "POST",
"path": "/api/v2/api-keys",
"parameters": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "name"
},
"scopes": {
"type": "array",
"description": "scopes"
}
},
"required": [
"name",
"scopes"
]
}
},
{
"name": "superagnt_connection_instantly_deleteAPIKey",
"description": "Delete api key",
"method": "DELETE",
"path": "/api/v2/api-keys/{id}",
"parameters": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the item to delete"
}
},
"required": [
"id"
]
}
},
{
"name": "superagnt_connection_instantly_listAuditLog",
"description": "List audit log",
"method": "GET",
"path": "/api/v2/audit-logs",
"parameters": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "The number of items to return"
},
"starting_after": {
"type": "string",
"description": "The ID of the last item in the previous page - used for pagination. You can use the value of the `next_starting_after` field from the previous response."
},
"activity_type": {
"type": "number",
"description": "Filter by activity type"
},
"search": {
"type": "string",
"description": "Search term to filter logs"
},
"start_date": {
"type": "string",
"description": "Start date to filter logs"
},
"end_date": {
"type": "string",
"description": "End date to filter logs"
}
}
}
},
{
"name": "superagnt_connection_instantly_listBackgroundJob",
"description": "List background job",
"method": "GET",
"path": "/api/v2/background-jobs",
"parameters": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "The number of items to return"
},
"starting_after": {
"type": "string",
"description": "starting_after"
},
"ids": {
"type": "string",
"description": "The ID of the job. Multiple IDs can be provided as a comma-separated list"
},
"included_ids": {
"type": "string",
"description": "The ID of the job to be included in the response. Multiple IDs can be provided as a comma-separated list"
},
"excluded_ids": {
"type": "string",
"description": "The ID of the job to be excluded from the response. Multiple IDs can be provided as a comma-separated list"
},
"type": {
"type": "string",
"description": "The type of the job"
},
"entity_type": {
"type": "string",
"description": "The type of the entity"
},
"entity_id": {
"type": "string",
"description": "The ID of the entity. Multiple IDs can be provided as a comma-separated list"
},
"status": {
"type": "string",
"description": "The status of the job. Multiple statuses can be provided as a comma-separated list. Valid statuses are: pending, in-progress, success, failed"
},
"sort_column": {
"type": "string",
"description": "The column to sort the results by"
},
"sort_order": {
"type": "string",
"description": "The order to sort the results by"
}
}
}
},
{
"name": "superagnt_connection_instantly_getBackgroundJob",
"description": "Get background job",
"method": "GET",
"path": "/api/v2/background-jobs/{id}",
"parameters": {
"type": "object",
"properties": {
"data_fields": {
"type": "string",
"description": "Comma-separated list of fields to include from the `data` object (e.g., \"success_count,failed_count\")."
},
"id": {
"type": "string",
"description": "The ID of the requested item"
}
},
"required": [
"id"
]
}
},
{
"name": "superagnt_connection_instantly_listBlockListEntry",
"description": "List block list entry",
"method": "GET",
"path": "/api/v2/block-lists-entries",
"parameters": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "The number of items to return"
},
"starting_after": {
"type": "string",
"description": "The ID of the last item in the previous page - used for pagination. You can use the value of the `next_starting_after` field from the previous response."
},
"domains_only": {
"type": "boolean",
"description": "Filter by domain"
},
"search": {
"type": "string",
"description": "Search by value"
}
}
}
},
{
"name": "superagnt_connection_instantly_createBlockListEntry",
"description": "Create block list entry",
"method": "POST",
"path": "/api/v2/block-lists-entries",
"parameters": {
"type": "object",
"properties": {
"bl_value": {
"type": "string",
"description": "The email or domain to block"
}
},
"required": [
"bl_value"
]
}
},
{
"name": "superagnt_connection_instantly_deleteallBlockListEntry",
"description": "Delete all block list entries",
"method": "DELETE",
"path": "/api/v2/block-lists-entries",
"parameters": {
"type": "object",
"properties": {
"domains_only": {
"type": "boolean",
"description": "Filter by domain"
},
"search": {
"type": "string",
"description": "Search by value"
}
}
}
},
{
"name": "superagnt_connection_instantly_getBlockListEntry",
"description": "Get block list entry",
"method": "GET",
"path": "/api/v2/block-lists-entries/{id}",
"parameters": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the requested item"
}
},
"required": [
"id"
]
}
},
{
"name": "superagnt_connection_instantly_patchBlockListEntry",
"description": "Patch block list entry",
"method": "PATCH",
"path": "/api/v2/block-lists-entries/{id}",
"parameters": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the item to update"
},
"bl_value": {
"type": "string",
"description": "The email or domain to block"
}
},
"required": [
"id"
]
}
},
{
"name": "superagnt_connection_instantly_deleteBlockListEntry",
"description": "Delete block list entry",
"method": "DELETE",
"path": "/api/v2/block-lists-entries/{id}",
"parameters": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the item to delete"
}
},
"required": [
"id"
]
}
},
{
"name": "superagnt_connection_instantly_createblukBlockListEntry",
"description": "Bulk create block list entry",
"method": "POST",
"path": "/api/v2/block-lists-entries/bulk-create",
"parameters": {
"type": "object",
"properties": {
"bl_values": {
"type": "array",
"description": "List of domains or emails to block"
}
},
"required": [
"bl_values"
]
}
},
{
"name": "superagnt_connection_instantly_deletebulkBlockListEntry",
"description": "Bulk delete block list entry",
"method": "POST",
"path": "/api/v2/block-lists-entries/bulk-delete",
"parameters": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"description": "List block list entry ids to delete"
}
},
"required": [
"ids"
]
}
},
{
"name": "superagnt_connection_instantly_downloadBlockListEntry",
"description": "Download all block list entries as CSV",
"method": "GET",
"path": "/api/v2/block-lists-entries/download",
"parameters": {
"type": "object",
"properties": {
"domains_only": {
"type": "boolean",
"description": "Filter by domain"
},
"search": {
"type": "string",
"description": "Search by value"
}
}
}
},
{
"name": "superagnt_connection_instantly_listCampaign",
"description": "List campaign",
"method": "GET",
"path": "/api/v2/campaigns",
"parameters": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "The number of items to return"
},
"starting_after": {
"type": "string",
"description": "The ID of the last item in the previous page - used for pagination. You can use the value of the `next_starting_after` field from the previous response."
},
"search": {
"type": "string",
"description": "Search by campaign name"
},
"tag_ids": {
"type": "string",
"description": "Filter campaigns by tag ids. Returns campaigns that have any of the specified tags assigned. You can specify multiple tag ids by separating them with a comma."
},
"ai_sales_agent_id": {
"type": "string",
"description": "Filter campaigns by AI Sales Agent ID. Returns campaigns that were created by the specified AI Sales Agent."
},
"status": {
"type": "number",
"description": "Filter campaigns by status using the campaign status enum value (e.g., ACTIVE, PAUSED)."
}
}
}
},
{
"name": "superagnt_connection_instantly_createCampaign",
"description": "Create campaign",
"method": "POST",
"path": "/api/v2/campaigns",
"parameters": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the campaign"
},
"pl_value": {
"type": [
"number",
"null"
],
"description": "Value of every positive lead"
},
"is_evergreen": {
"type": [
"boolean",
"null"
],
"description": "Whether the campaign is evergreen"
},
"campaign_schedule": {
"type": "object",
"description": "Campaign schedule"
},
"sequences": {
"type": "array",
"description": "List of sequences (the actual email copy). Even though this field is an array, only the first element is used, so please provide only one array item, and add the steps to that array"
},
"email_gap": {
"type": [
"number",
"null"
],
"description": "The gap between emails in minutes"
},
"random_wait_max": {
"type": [
"number",
"null"
],
"description": "The maximum random wait time in minutes"
},
"text_only": {
"type": [
"boolean",
"null"
],
"description": "Whether the campaign is text only"
},
"first_email_text_only": {
"type": [
"boolean",
"null"
],
"description": "Whether the campaign is send the first email as a text only"
},
"email_list": {
"type": "array",
"description": "List of accounts to use for sending emails"
},
"daily_limit": {
"type": [
"number",
"null"
],
"description": "The daily limit for sending emails"
},
"stop_on_reply": {
"type": [
"boolean",
"null"
],
"description": "Whether to stop the campaign on reply"
},
"email_tag_list": {
"type": "array",
"description": "List of tags to use for sending emails"
},
"link_tracking": {
"type": [
"boolean",
"null"
],
"description": "Whether to track links in emails"
},
"open_tracking": {
"type": "boolean",
"description": "Whether to track opens in emails"
},
"stop_on_auto_reply": {
"type": [
"boolean",
"null"
],
"description": "Whether to stop the campaign on auto reply"
},
"daily_max_leads": {
"type": [
"number",
"null"
],
"description": "The daily maximum new leads to contact"
},
"prioritize_new_leads": {
"type": [
"boolean",
"null"
],
"description": "Whether to prioritize new leads"
},
"auto_variant_select": {
"type": [
"object",
"null"
],
"description": "Auto variant select settings"
},
"match_lead_esp": {
"type": [
"boolean",
"null"
],
"description": "Whether to match leads by ESP"
},
"stop_for_company": {
"type": [
"boolean",
"null"
],
"description": "Whether to stop the campaign for the entire company(domain) when a lead replies"
},
"insert_unsubscribe_header": {
"type": [
"boolean",
"null"
],
"description": "Whether to insert an unsubscribe header in emails"
},
"allow_risky_contacts": {
"type": [
"boolean",
"null"
],
"description": "Whether to allow risky contacts"
},
"disable_bounce_protect": {
"type": [
"boolean",
"null"
],
"description": "Whether to disable bounce protection"
},
"limit_emails_per_company_override": {
"type": [
"object",
"null"
],
"description": "Overrides the workspace-wide limit emails per company setting for this campaign."
},
"cc_list": {
"type": "array",
"description": "List of accounts to CC on emails"
},
"bcc_list": {
"type": "array",
"description": "List of accounts to BCC on emails"
},
"owned_by": {
"type": [
"string",
"null"
],
"description": "Owner ID"
},
"ai_sdr_id": {
"type": [
"string",
"null"
],
"description": "AI Sales Agent ID that created this campaign"
},
"provider_routing_rules": {
"type": "array",
"description": "Auto variant select settings"
}
},
"required": [
"name",
"campaign_schedule"
]
}
},
{
"name": "superagnt_connection_instantly_activateCampaign",
"description": "Activate(start), or resume a campaign",
"method": "POST",
"path": "/api/v2/campaigns/{id}/activate",
"parameters": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Campaign ID"
}
},
"required": [
"id"
]
}
},
{
"name": "superagnt_connection_instantly_pauseCampaign",
"description": "Stop(or pause) a campaign",
"method": "POST",
"path": "/api/v2/campaigns/{id}/pause",
"parameters": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Campaign ID"
}
},
"required": [
"id"
]
}
},
{
"name": "superagnt_connection_instantly_getCampaign",
"description": "Get campaign",
"method": "GET",
"path": "/api/v2/campaigns/{id}",
"parameters": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the requested item"
}
},
"required": [
"id"
]
}
},
{
"name": "superagnt_connection_instantly_patchCampaign",
"description": "Patch campaign",
"method": "PATCH",
"path": "/api/v2/campaigns/{id}",
"parameters": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the item to update"
},
"name": {
"type": "string",
"description": "Name of the campaign"
},
"pl_value": {
"type": [
"number",
"null"
],
"description": "Value of every positive lead"
},
"is_evergreen": {
"type": [
"boolean",
"null"
],
"description": "Whether the campaign is evergreen"
},
"campaign_schedule": {
"type": "object",
"description": "Campaign schedule"
},
"sequences": {
"type": "array",
"description": "List of sequences (the actual email copy). Even though this field is an array, only the first element is used, so please provide only one array item, and add the steps to that array"
},
"email_gap": {
"type": [
"number",
"null"
],
"description": "The gap between emails in minutes"
},
"random_wait_max": {
"type": [
"number",
"null"
],
"description": "The maximum random wait time in minutes"
},
"text_only": {
"type": [
"boolean",
"null"
],
"description": "Whether the campaign is text only"
},
"first_email_text_only": {
"type": [
"boolean",
"null"
],
"description": "Whether the campaign is send the first email as a text only"
},
"email_list": {
"type": "array",
"description": "List of accounts to use for sending emails"
},
"daily_limit": {
"type": [
"number",
"null"
],
"description": "The daily limit for sending emails"
},
"stop_on_reply": {
"type": [
"boolean",
"null"
],
"description": "Whether to stop the campaign on reply"
},
"email_tag_list": {
"type": "array",
"description": "List of tags to use for sending emails"
},
"link_tracking": {
"type": [
"boolean",
"null"
],
"description": "Whether to track links in emails"
},
"open_tracking": {
"type": "boolean",
"description": "Whether to track opens in emails"
},
"stop_on_auto_reply": {
"type": [
"boolean",
"null"
],
"description": "Whether to stop the campaign on auto reply"
},
"daily_max_leads": {
"type": [
"number",
"null"
],
"description": "The daily maximum new leads to contact"
},
"prioritize_new_leads": {
"type": [
"boolean",
"null"
],
"description": "Whether to prioritize new leads"
},
"auto_variant_select": {
"type": [
"object",
"null"
],
"description": "Auto variant select settings"
},
"match_lead_esp": {
"type": [
"boolean",
"null"
],
"description": "Whether to match leads by ESP"
},
"stop_for_company": {
"type": [
"boolean",
"null"
],
"description": "Whether to stop the campaign for the entire company(domain) when a lead replies"
},
"insert_unsubscribe_header": {
"type": [
"boolean",
"null"
],
"description": "Whether to insert an unsubscribe header in emails"
},
"allow_risky_contacts": {
"type": [
"boolean",
"null"
],
"description": "Whether to allow risky contacts"
},
"disable_bounce_protect": {
"type": [
"boolean",
"null"
],
"description": "Whether to disable bounce protection"
},
"limit_emails_per_company_override": {
"type": [
"object",
"null"
],
"description": "Overrides the workspace-wide limit emails per company setting for this campaign."
},
"cc_list": {
"type": "array",
"description": "List of accounts to CC on emails"
},
"bcc_list": {
"type": "array",
"description": "List of accounts to BCC on emails"
},
"owned_by": {
"type": [
"string",
"null"
],
"description": "Owner ID"
},
"provider_routing_rules": {
"type": "array",
"description": "Auto variant select settings"
}
},
"required": [
"id"
]
}
},
{
"name": "superagnt_connection_instantly_deleteCampaign",
"description": "Delete campaign",
"method": "DELETE",
"path": "/api/v2/campaigns/{id}",
"parameters": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the item to delete"
}
},
"required": [
"id"
]
}
},
{
"name": "superagnt_connection_instantly_searchByContact",
"description": "Search campaigns by lead email",
"method": "GET",
"path": "/api/v2/campaigns/search-by-contact",
"parameters": {
"type": "object",
"properties": {
"search": {
"type": "string",
"description": "Search by lead email"
},
"sort_column": {
"type": "string",
"description": "Sort campaigns by column name"
},
"sort_order": {
"type": "string",
"description": "Sort direction"
}
}
}
},
{
"name": "superagnt_connection_instantly_getCampaignAnalytics",
"description": "Get campaign(s) analytics",
"method": "GET",
"path": "/api/v2/campaigns/analytics",
"parameters": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A campaign ID to get the analytics for. Leave this field empty to get the analytics for all campaigns"
},
"ids": {
"type": "array",
"description": "ids"
},
"start_date": {
"type": "string",
"description": "Start date"
},
"end_date": {
"type": "string",
"description": "End date"
},
"exclude_total_leads_count": {
"type": "boolean",
"description": "Exclude the total leads from the result. Setting this to true will considerably decrease the response time"
}
}
}
},
{
"name": "superagnt_connection_instantly_getCampaignAnalyticsOverview",
"description": "Get campaign(s) analytics overview",
"method": "GET",
"path": "/api/v2/campaigns/analytics/overview",
"parameters": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A campaign ID to get the analytics overview for. Leave this field empty to get the analytics overview for all campaigns"
},
"ids": {
"type": "array",
"description": "ids"
},
"start_date": {
"type": "string",
"description": "Start date"
},
"end_date": {
"type": "string",
"description": "End date"
},
"campaign_status": {
"type": "number",
"description": "Filter by campaign status (only the analytics for the campaigns with the specified status will be returned)"
},
"expand_crm_events": {
"type": "boolean",
"description": "When `true`, calculates the total of all the lead interest status update events instead of only the first occurrence for each contact. This will affect the following fields: `total_opportunities`, `total_interested`, `total_meeting_booked`, `total_meeting_completed`, and `total_closed`. Example: if a lead goes from interested to meeting booked to closed, it will count as 3 events (total_interested: 1, total_meeting_booked_1, and total_closed: 1) when this parameter is set to true, and as 1 event (total_interested) when it is set to false (default)."
}
}
}
},
{
"name": "superagnt_connection_instantly_getDailyCampaignAnalytics",
"description": "Get daily campaign analytics",
"method": "GET",
"path": "/api/v2/campaigns/analytics/daily",
"parameters": {
"type": "object",
"properties": {
"campaign_id": {
"type": "string",
"description": "Campaign ID (optional). Leave this field empty to get the analytics for all campaigns"
},
"start_date": {
"type": "string",
"description": "Start date"
},
"end_date": {
"type": "string",
"description": "End date"
},
"campaign_status": {
"type": "number",
"description": "Filter by campaign status (only the analytics for the campaigns with the specified status will be returned)"
}
}
}
},
{
"name": "superagnt_connection_instantly_getCampaignStepsAnalytics",
"description": "Get campaign steps analytics",
"method": "GET",
"path": "/api/v2/campaigns/analytics/steps",
"parameters": {
"type": "object",
"properties": {
"campaign_id": {
"type": "string",
"description": "Campaign ID (optional). Leave this field empty to get the analytics for all campaigns"
},
"start_date": {
"type": "string",
"description": "Start date"
},
"end_date": {
"type": "string",
"description": "End date"
},
"include_opportunities_count": {
"type": "boolean",
"description": "Whether to include the opportunities count per step. If this field is true then `opportunities` and `unique_opportunities` fields will be included in the response"
}
}
}
},
{
"name": "superagnt_connection_instantly_shareCampaign",
"description": "Share a campaign",
"method": "POST",
"path": "/api/v2/campaigns/{id}/share",
"parameters": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Campaign ID"
}
},
"required": [
"id"
]
}
},
{
"name": "superagnt_connection_instantly_createFromExport",
"description": "Create campaign from shared one",
"method": "POST",
"path": "/api/v2/campaigns/{id}/from-export",
"parameters": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Campaign ID"
}
},
"required": [
"id"
]
}
},
{
"name": "superagnt_connection_instantly_exportCampaign",
"description": "Export campaign to JSON format",
"method": "POST",
"path": "/api/v2/campaigns/{id}/export",
"parameters": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Campaign ID"
}
},
"required": [
"id"
]
}
},
{
"name": "superagnt_connection_instantly_duplicate",
"description": "Duplicate campaign",
"method": "POST",
"path": "/api/v2/campaigns/{id}/duplicate",
"parameters": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Campaign ID"
},
"name": {
"type": "string",
"description": "Campaign new name (optional). If not provided, it will default to CAMPAIGN NAME (copy)."
}
},
"required": [
"id"
]
}
},
{
"name": "superagnt_connection_instantly_countLaunched",
"description": "Get launched campaigns count",
"method": "GET",
"path": "/api/v2/campaigns/count-launched",
"parameters": {
"type": "object",
"properties": {}
}
},
{
"name": "superagnt_connection_instantly_addVariables",
"description": "Add campaign variables",
"method": "POST",
"path": "/api/v2/campaigns/{id}/variables",
"parameters": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Campaign ID"
},
"variables": {
"type": "array",
"description": "variables"
}
},
"required": [
"id"
]
}
},
{
"name": "superagnt_connection_instantly_getCampaignSendingStatus",
"description": "Get campaign sending status",
"method": "GET",
"path": "/api/v2/campaigns/{id}/sending-status",
"parameters": {
"type": "object",
"properties": {
"with_ai_summary": {
"type": "boolean",
"description": "Include AI-generated summary"
},
"id": {
"type": "string",
"description": "Campaign ID"
}
},
"required": [
"id"
]
}
},
{
"name": "superagnt_connection_instantly_listPhoneNumbers",
"description": "List phone numbers",
"method": "GET",
"path": "/api/v2/crm-actions/phone-numbers",
"parameters": {
"type": "object",
"properties": {}
}
},
{
"name": "superagnt_connection_instantly_deletePhoneNumber",
"description": "Delete phone number",
"method": "DELETE",
"path": "/api/v2/crm-actions/phone-numbers/{id}",
"parameters": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The phone number record id to delete"
}
},
"required": [
"id"
]
}
},
{
"name": "superagnt_connection_instantly_listCustomTagMapping",
"description": "List custom tag mapping",
"method": "GET",
"path": "/api/v2/custom-tag-mappings",
"parameters": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "The number of items to return"
},
"starting_after": {
"type": "string",
"description": "The ID of the last item in the previous page - used for pagination. You can use the value of the `next_starting_after` field from the previous response."
},
"resource_ids": {
"type": "string",
"description": "The list of resource ids to filter custom tag mappings by. A resource id is the id of an account or a campaign."
}
}
}
},
{
"name": "superagnt_connection_instantly_listCustomTag",
"description": "List custom tag",
"method": "GET",
"path": "/api/v2/custom-tags",
"parameters": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "The number of items to return"
},
"starting_after": {
"type": "string",
"description": "The ID of the last item in the previous page - used for pagination. You can use the value of the `next_starting_after` field from the previous response."
},
"search": {
"type": "string",
"description": "The search query to filter custom tags."
},
"resource_ids": {
"type": "string",
"description": "The list of resource ids to filter custom tags by. A resource id is the id of an account or a campaign."
},
"tag_ids": {
"type": "string",
"description": "The list of tag ids to filter custom tags by."
}
}
}
},
{
"name": "superagnt_connection_instantly_createCustomTag",
"description": "Create custom tag",
"method": "POST",
"path": "/api/v2/custom-tags",
"parameters": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Display label for the custom tag"
},
"description": {
"type": [
"string",
"null"
],
"description": "Detailed description of the custom tag purpose"
}
},
"required": [
"label"
]
}
},
{
"name": "superagnt_connection_instantly_getCustomTag",
"description": "Get custom tag",
"method": "GET",
"path": "/api/v2/custom-tags/{id}",
"parameters": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the requested item"
}
},
"required": [
"id"
]
}
},
{
"name": "superagnt_connection_instantly_patchCustomTag",
"description": "Patch custom tag",
"method": "PATCH",
"path": "/api/v2/custom-tags/{id}",
"parameters": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the item to update"
},
"label": {
"type": "string",
"description": "Display label for the custom tag"
},
"description": {
"type": [
"string",
"null"
],
"description": "Detailed description of the custom tag purpose"
}
},
"required": [
"id"
]
}
},
{
"name": "superagnt_connection_instantly_deleteCustomTag",
"description": "Delete custom tag",
"method": "DELETE",
"path": "/api/v2/custom-tags/{id}",
"parameters": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the item to delete"
}
},
"required": [
"id"
]
}
},
{
"name": "superagnt_connection_instantly_toggleTagResource",
"description": "Assign or unassign tags to resources",
"method": "POST",
"path": "/api/v2/custom-tags/toggle-resource",
"parameters": {
"type": "object",
"properties": {
"tag_ids": {
"type": "array",
"description": "The list of tag ids to assign or unassign"
},
"resource_type": {
"type": "number",
"description": "The resource type to assign or unassign the tags to"
},
"resource_ids": {
"type": "array",
"description": "The list of resource ids to assign or unassign. A resource id is the id of an account or a campaign."
},
"assign": {
"type": "boolean",
"description": "Whether to assign the tags to the resources."
},
"selected_all": {
"type": "boolean",
"description": "Whether to select all resources."
},
"filter": {
"type": "object",
"description": "The filter to apply to the resources. These are only used when `selected_all` is true."
}
},
"required": [
"tag_ids",
"resource_type",
"resource_ids",
"assign"
]
}
},
{
"name": "superagnt_connection_instantly_listDFYEmailAccountOrder",
"description": "List dfy email account order",
"method": "GET",
"path": "/api/v2/dfy-email-account-orders",
"parameters": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "The number of items to return"
},
"starting_after": {
"type": "string",
"description": "The ID of the last item in the previous page - used for pagination. You can use the value of the `next_starting_after` field from the previous response."
}
}
}
},
{
"name": "superagnt_connection_instantly_createDFYEmailAccountOrder",
"description": "Place a DFY email account order",
"method": "POST",
"path": "/api/v2/dfy-email-account-orders",
"parameters": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of domains and accounts to order"
},
"order_type": {
"type": "string",
"description": "The type of order to place. Please check the docs because this endpoint performs different actions based on the order type."
},
"simulation": {
"type": "boolean",
"description": "Whether to run a simulation of the order ot not. If set to true, the order will NOT be placed, your card will NOT be charged, and only a price quote will be returned. We will still check the validity of the order and the accounts, and return the results of the validation (if the order_is_valid field is true, then the order would be valid and could be placed)."
}
},
"required": [
"items",
"order_type"
]
}
},
{
"name": "superagnt_connection_instantly_generateSimilarDomains",
"description": "Generate similar available domains",
"method": "POST",
"path": "/api/v2/dfy-email-account-orders/domains/similar",
"parameters": {
"type": "object",
"properties": {
"domain": {
"type": "string",
"description": "The domain to base the suggestions on"
},
"tlds": {
"type": "array",
"description": "The extensions (tlds) to use for generating similar domains. By default, we will use com and org."
}
},
"required": [
"domain"
]
}
},
{
"name": "superagnt_connection_instantly_checkDomainsAvailability",
"description": "Check domains availability",
"method": "POST",
"path": "/api/v2/dfy-email-account-orders/domains/check",
"parameters": {
"type": "object",
"properties": {
"domains": {
"type": "array",
"description": "List of domains to check"
}
},
"required": [
"domains"
]
}
},
{
"name": "superagnt_connection_instantly_preWarmedUpDomainsList",
"description": "Get pre-warmed up domains",
"method": "POST",
"path": "/api/v2/dfy-email-account-orders/domains/pre-warmed-up-list",
"parameters": {
"type": "object",
"properties": {
"extensions": {
"type": "array",
"description": "A list of domain extensions to filter the results by. If not provided, all available extensions will be returned."
},
"search": {
"type": "string",
"description": "A search string to filter the domains by. This can be a partial or full domain name."
}
}
}
},
{
"name": "superagnt_connection_instantly_list_dfy_accounts",
"description": "List DFY ordered email accounts",
"method": "GET",
"path": "/api/v2/dfy-email-account-orders/accounts",
"parameters": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "The number of items to return"
},
"starting_after": {
"type": "string",
"description": "The ID of the last item in the previous page - used for pagination. You can use the value of the `next_starting_after` field from the previous response."
},
"with_passwords": {
"type": "boolean",
"description": "Whether to include passwords in the response"
}
}
}
},
{
"name": "superagnt_connection_instantly_cancelDFYEmailAccounts",
"description": "Cancel dfy email accounts",
"method": "POST",
"path": "/api/v2/dfy-email-account-orders/accounts/cancel",
"parameters": {
"type": "object",
"properties": {
"accounts": {
"type": "array",
"description": "List of emails to cancel the DFY email accounts for."
}
},
"required": [
"accounts"
]
}
},
{
"name": "superagnt_connection_instantly_sendTestEmail",
"description": "Send a test email",
"method": "POST",
"path": "/api/v2/emails/test",
"parameters": {
"type": "object",
"properties": {
"eaccount": {
"type": "string",
"description": "The email account that will be used to send this email. It has to be an email account connected to your workspace."
},
"to_address_email_list": {
"type": "string",
"description": "Comma-separated list of recipients that will receive the test email."
},
"subject": {
"type": "string",
"description": "Subject line of the test email."
},
"body": {
"type": "object",
"description": "HTML body of the test email."
}
},
"required": [
"eaccount",
"to_address_email_list",
"subject",
"body"
]
}
},
{
"name": "superagnt_connection_instantly_replyToEmail",
"description": "Reply to an email",
"method": "POST",
"path": "/api/v2/emails/reply",
"parameters": {
"type": "object",
"properties": {
"eaccount": {
"type": "string",
"description": "The email account that will be used to send this email. It has to be an email account connected to your workspace"
},
"reply_to_uuid": {
"type": "string",
"description": "The id of the email to reply to"
},
"subject": {
"type": "string",
"description": "Subject line of the email message"
},
"body": {
"type": "object",
"description": "The email body. You can specify either the `html` or the `text` field, or both"
},
"cc_address_email_list": {
"type": "string",
"description": "Comma-separated list of CC email addresses"
},
"bcc_address_email_list": {
"type": "string",
"description": "Comma-separated list of BCC email addresses"
},
"reminder_ts": {
"type": "string",
"description": "If provided then a reminder will be attached to this email, you will see this reminder in the Unibox in the web app"
},
"assigned_to": {
"type": "string",
"description": "The user id assigned to the lead"
}
},
"required": [
"reply_to_uuid",
"eaccount",
"subject",
"body"
]
}
},
{
"name": "superagnt_connection_instantly_forwardEmail",
"description": "Forward an email",
"method": "POST",
"path": "/api/v2/emails/forward",
"parameters": {
"type": "object",
"properties": {
"eaccount": {
"type": "string",
"description": "The email account that will be used to send this email. It has to be an email account connected to your workspace"
},
"reply_to_uuid": {
"type": "string",
"description": "The id of the email you want to forward"
},
"to_address_email_list": {
"type": "string",
"description": "Comma-separated list of recipients that will receive the forwarded email"
},
"subject": {
"type": "string",
"description": "Subject line of the forwarded email message"
},
"body": {
"type": "object",
"description": "The email body. You can specify either the `html` or the `text` field, or both"
},
"cc_address_email_list": {
"type": "string",
"description": "Comma-separated list of CC email addresses"
},
"bcc_address_email_list": {
"type": "string",
"description": "Comma-separated list of BCC email addresses"
},
"reply_to": {
"type": "string",
"description": "Reply-to email address that recipients should use when replying"
},
"forwarded_attachments": {
"type": "string",
"description": "JSON-encoded forwarded attachment metadata from the original email"
},
"assigned_to": {
"type": "string",
"description": "The user id assigned to the lead"
}
},
"required": [
"reply_to_uuid",
"to_address_email_list",
"eaccount",
"subject",
"body"
]
}
},
{
"name": "superagnt_connection_instantly_listEmail",
"description": "List email",
"method": "GET",
"path": "/api/v2/emails",
"parameters": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "The number of items to return"
},
"starting_after": {
"type": "string",
"description": "The ID of the last item in the previous page - used for pagination. You can use the value of the `next_starting_after` field from the previous response."
},
"search": {
"type": "string",
"description": "The search query to filter emails. It can be an email address (the lead email address), or a special string that starts with \"thread:\" to search for emails in a specific thread. If you want to search for emails in a specific thread, use the \"thread:\" prefix followed by the thread ID (e.g., \"thread:123e4567-e89b-12d3-a456-426614174000\")."
},
"campaign_id": {
"type": "string",
"description": "The ID of the campaign to filter emails by."
},
"list_id": {
"type": "string",
"description": "The ID of the lead list to filter emails by."
},
"i_status": {
"type": "number",
"description": "The status of the emails to filter by."
},
"eaccount": {
"type": "string",
"description": "The email account that was used to send this email. You can filter by multiple email accounts by providing a comma-separated list of email addresses."
},
"is_unread": {
"type": "boolean",
"description": "Whether the email is unread."
},
"has_reminder": {
"type": "boolean",
"description": "has_reminder"
},
"mode": {
"type": "string",
"description": "The mode to filter emails by."
},
"preview_only": {
"type": "boolean",
"description": "Whether to only return the preview of the emails."
},
"sort_order": {
"type": "string",
"description": "The order to sort the emails by (based on the email creation date). Default is \"desc\"."
},
"scheduled_only": {
"type": "boolean",
"description": "Whether to only return the scheduled emails."
},
"assigned_to": {
"type": "string",
"description": "The ID of the user to filter emails by."
},
"lead": {
"type": "string",
"description": "The email of the lead to filter emails by."
},
"company_domain": {
"type": "string",
"description": "The domain of the company to filter emails by."
},
"marked_as_done": {
"type": "boolean",
"description": "Whether the email is marked as done."
},
"email_type": {
"type": "string",
"description": "The type of the email to filter by."
},
"min_timestamp_created": {
"type": "string",
"description": "Filter emails created after this timestamp (ISO format)"
},
"max_timestamp_created": {
"type": "string",
"description": "Filter emails created before this timestamp (ISO format)"
},
"latest_of_thread": {
"type": "boolean",
"description": "Whether to only return the latest email in each thread."
}
}
}
},
{
"name": "superagnt_connection_instantly_getEmail",
"description": "Get email",
"method": "GET",
"path": "/api/v2/emails/{id}",
"parameters": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the requested item"
}
},
"required": [
"id"
]
}
},
{
"name": "superagnt_connection_instantly_patchEmail",
"description": "Patch email",
"method": "PATCH",
"path": "/api/v2/emails/{id}",
"parameters": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the item to update"
},
"is_unread": {
"type": [
"number",
"null"
],
"description": "Indicates if the email is unread"
},
"reminder_ts": {
"type": [
"string",
"null"
],
"description": "Timestamp for the reminder."
}
},
"required": [
"id"
]
}
},
{
"name": "superagnt_connection_instantly_deleteEmail",
"description": "Delete email",
"method": "DELETE",
"path": "/api/v2/emails/{id}",
"parameters": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the item to delete"
}
},
"required": [
"id"
]
}
},
{
"name": "superagnt_connection_instantly_countUnreadEmails",
"description": "Count unread emails",
"method": "GET",
"path": "/api/v2/emails/unread/count",
"parameters": {
"type": "object",
"properties": {}
}
},
{
"name": "superagnt_connection_instantly_markThreadAsRead",
"description": "Mark all emails in a thread as read",
"method": "POST",
"path": "/api/v2/emails/threads/{thread_id}/mark-as-read",
"parameters": {
"type": "object",
"properties": {
"thread_id": {
"type": "string",
"description": "thread_id"
}
},
"required": [
"thread_id"
]
}
},
{
"name": "superagnt_connection_instantly_listInboxPlacementAnalytics",
"description": "List inbox placement analytics",
"method": "GET",
"path": "/api/v2/inbox-placement-analytics",
"parameters": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "The number of items to return"
},
"starting_after": {
"type": "string",
"description": "The ID of the last item in the previous page - used for pagination. You can use the value of the `next_starting_after` field from the previous response."
},
"test_id": {
"type": "string",
"description": "test_id"
},
"date_from": {
"type": "string",
"description": "date_from"
},
"date_to": {
"type": "string",
"description": "date_to"
},
"recipient_geo": {
"type": "string",
"description": "A comma-separated list of recipient geo values."
},
"recipient_type": {
"type": "string",
"description": "A comma-separated list of recipient type values."
},
"recipient_esp": {
"type": "string",
"description": "A comma-separated list of recipient ESP values."
},
"sender_email": {
"type": "string",
"description": "sender_email"
}
},
"required": [
"test_id"
]
}
},
{
"name": "superagnt_connection_instantly_getInboxPlacementAnalytics",
"description": "Get inbox placement analytics",
"method": "GET",
"path": "/api/v2/inbox-placement-analytics/{id}",
"parameters": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the requested item"
}
},
"required": [
"id"
]
}
},
{
"name": "superagnt_connection_instantly_inbox_stats_by_test_id",
"description": "Retrieve inbox placement analytics stats by test id",
"method": "POST",
"path": "/api/v2/inbox-placement-analytics/stats-by-test-id",
"parameters": {
"type": "object",
"properties": {
"test_ids": {
"type": "array",
"description": "test_ids"
},
"date_from": {
"type": "string",
"description": "date_from"
},
"date_to": {
"type": "string",
"description": "date_to"
},
"recipient_geo": {
"type": "array",
"description": "recipient_geo"
},
"recipient_type": {
"type": "array",
"description": "recipient_type"
},
"recipient_esp": {
"type": "array",
"description": "recipient_esp"
},
"sender_email": {
"type": "string",
"description": "sender_email"
}
},
"required": [
"test_ids"
]
}
},
{
"name": "superagnt_connection_instantly_inbox_deliverability",
"description": "Retrieve inbox placement analytics deliverability insights",
"method": "POST",
"path": "/api/v2/inbox-placement-analytics/deliverability-insights",
"parameters": {
"type": "object",
"properties": {
"test_id": {
"type": "string",
"description": "test_id"
},
"date_from": {
"type": "string",
"description": "date_from"
},
"date_to": {
"type": "string",
"description": "date_to"
},
"previous_date_from": {
"type": "string",
"description": "previous_date_from"
},
"previous_date_to": {
"type": "string",
"description": "previous_date_to"
},
"show_previous": {
"type": "boolean",
"description": "show_previous"
},
"recipient_geo": {
"type": "array",
"description": "recipient_geo"
},
"recipient_type": {
"type": "array",
"description": "recipient_type"
},
"recipient_esp": {
"type": "array",
"description": "recipient_esp"
}
},
"required": [
"test_id"
]
}
},
{
"name": "superagnt_connection_instantly_inbox_stats_by_date",
"description": "Get inbox placement analytics stats by date",
"method": "POST",
"path": "/api/v2/inbox-placement-analytics/stats-by-date",
"parameters": {
"type": "object",
"properties": {
"test_id": {
"type": "string",
"description": "test_id"
},
"date_from": {
"type": "string",
"description": "date_from"
},
"date_to": {
"type": "string",
"description": "date_to"
},
"recipient_geo": {
"type": "array",
"description": "recipient_geo"
},
"recipient_type": {
"type": "array",
"description": "recipient_type"
},
"recipient_esp": {
"type": "array",
"description": "recipient_esp"
},
"sender_email": {
"type": "string",
"description": "sender_email"
}
},
"required": [
"test_id"
]
}
},
{
"name": "superagnt_connection_instantly_list_inbox_reports",
"description": "List inbox placement blacklist & spamassassin report",
"method": "GET",
"path": "/api/v2/inbox-placement-reports",
"parameters": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "The number of items to return"
},
"starting_after": {
"type": "string",
"description": "The ID of the last item in the previous page - used for pagination. You can use the value of the `next_starting_after` field from the previous response."
},
"test_id": {
"type": "string",
"description": "test_id"
},
"date_from": {
"type": "string",
"description": "date_from"
},
"date_to": {
"type": "string",
"description": "date_to"
},
"skip_spam_assassin_report": {
"type": "boolean",
"description": "Flag to skip including spam_assassin_report JSON"
},
"skip_blacklist_report": {
"type": "boolean",
"description": "Flag to skip including blacklist_report JSON"
}
},
"required": [
"test_id"
]
}
},
{
"name": "superagnt_connection_instantly_get_inbox_report",
"description": "Get inbox placement blacklist & spamassassin report",
"method": "GET",
"path": "/api/v2/inbox-placement-reports/{id}",
"parameters": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the requested item"
}
},
"required": [
"id"
]
}
},
{
"name": "superagnt_connection_instantly_listInboxPlacementTest",
"description": "List inbox placement test",
"method": "GET",
"path": "/api/v2/inbox-placement-tests",
"parameters": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "The number of items to return"
},
"starting_after": {
"type": "string",
"description": "The ID of the last item in the previous page - used for pagination. You can use the value of the `next_starting_after` field from the previous response."
},
"search": {
"type": "string",
"description": "search"
},
"status": {
"type": "number",
"description": "status"
},
"sort_order": {
"type": "string",
"description": "Sort order for the results. Results are always sorted by id (which is timestamp-sorted due to UUIDv7)."
}
}
}
},
{
"name": "superagnt_connection_instantly_createInboxPlacementTest",
"description": "Create inbox placement test",
"method": "POST",
"path": "/api/v2/inbox-placement-tests",
"parameters": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the inbox placement test"
},
"delivery_mode": {
"type": [
"null",
"number"
],
"description": "Whether to send emails one by one or all together"
},
"description": {
"type": [
"string",
"null"
],
"description": "Description of the inbox placement test"
},
"schedule": {
"type": "object",
"description": "Specifies the date and time when the automated inbox placement tests will be sent."
},
"type": {
"type": "number",
"description": "Whether the inbox placement test is a one-time test or an automated test"
},
"sending_method": {
"type": "number",
"description": "Whether the inbox placement test will be sent from Instantly or from outside Instantly"
},
"campaign_id": {
"type": [
"null",
"string"
],
"description": "Campaign ID"
},
"email_subject": {
"type": "string",
"description": "Email subject of the inbox placement test"
},
"email_body": {
"type": "string",
"description": "Email body of the inbox placement test"
},
"emails": {
"type": "array",
"description": "Emails to send the inbox placement test to"
},
"test_code": {
"type": [
"string",
"null"
],
"description": "Code for identifying the inbox placement tests in the email body from outside Instantly"
},
"tags": {
"type": [
"array",
"null"
],
"description": "List of tag IDs to use for sending emails"
},
"text_only": {
"type": [
"boolean",
"null"
],
"description": "Disables open tracking"
},
"recipients_labels": {
"type": "array",
"description": "A list of email providers and their corresponding types to which emails will be sent. To retrieve the available options, use the `GET: /inbox-placement-tests/email-service-provider-options` endpoint"