Imported from superagnt/leverage (skills/core/instantly-outreach/SKILL.md). Install upstream with npx skills add superagnt/leverage --skill instantly-outreach. Copyright stays with the author (MIT-0).

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.

Best install: connect the MCP server

If this client speaks MCP, connect the workspace server instead of using this skill's curl calls — once the Instantly AI account is connected in the dashboard, its tools appear on the server automatically 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

Everything below works on curl-only environments with just the API key.

Prerequisites

1. An API key — get one from the dashboard and export it as SUPERAGNT_API_KEY.
2. A connected Instantly AI account — connect it in the connections dashboard. 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)

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

Tool Schemas

The following JSON defines every operation with its parameters. Each tool maps to an API endpoint under the base URL.

[
  {
    "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",
      "pr

*Truncated - read the full file at https://github.com/superagnt/leverage/blob/175562e6fae6320cecfbe0dc5eeb54cccc017ac0/skills/core/instantly-outreach/SKILL.md.*