API Key

API Explorer (2.0.0)

The entire API V2 documentation is interactive and can be tested here. To the right side of every endpoint you will see a box with an example request. You can click on the "Try it" button to send a request to the server right from the docs. You will need to provide an API key by clicking the ApiKeyAuth_token blue text.

Languages
Servers
Instantly API Server

https://api.instantly.ai/

Mock server

https://developer.instantly.ai/_mock/api/v2/

Analytics

Endpoints related to analytics

Operations

Account

An email account that can be used to send campaigns

Operations

Campaign

A campaign that can be sent to a list of recipients

Operations

Email

A campaign email, a reply, a manually sent email, or any other email that's visible in the Unibox

Operations

Email Verification

A single email verification

Operations

Lead List

A list used to store leads

Operations

Inbox Placement Test

An inbox placement test

Operations

Inbox Placement Analytics

Analytics data for individual emails in inbox placement tests

Operations

Inbox Placement Blacklist & SpamAssassin Report

Report data for an inbox placement test

Operations

API Key

API Key

Operations

API Key

API Key

idstring(uuid)read-onlyrequired
Example: "019affad-22ef-7734-841f-87e02240cc76"
namestringrequired
Example: "My API Key"
scopesArray of stringsrequired
Items Enum"all:all""all:create""all:read""all:update""all:delete""ai_agents:all""ai_agents:create""ai_agents:read""ai_agents:update""ai_agents:delete"
Example: ["campaigns:create"]
keystringread-onlyrequired
Example: "a1b2c3d4e5f6g7h8i9j0"
organization_idstring(uuid)read-onlyrequired
Example: "019affad-22f7-7579-9c92-89a3c4e07a85"
timestamp_createdstring(date-time)read-onlyrequired
Example: "2025-12-08T20:35:28.119Z"
timestamp_updatedstring(date-time)read-onlyrequired
Example: "2025-12-08T20:35:28.119Z"
{
  "id": "019affad-22ef-7734-841f-87e02240cc76",
  "name": "My API Key",
  "scopes": [
    "campaigns:create"
  ],
  "key": "a1b2c3d4e5f6g7h8i9j0",
  "organization_id": "019affad-22f7-7579-9c92-89a3c4e07a85",
  "timestamp_created": "2025-12-08T20:35:28.119Z",
  "timestamp_updated": "2025-12-08T20:35:28.119Z"
}

Create api key

Request

Requires one of the following scopes: api_keys:create, api_keys:all, all:create, all:all

Bodyapplication/jsonrequired

The API Key to create

namestringrequired
Example: "My API Key"
scopesArray of stringsrequired
Items Enum"all:all""all:create""all:read""all:update""all:delete""ai_agents:all""ai_agents:create""ai_agents:read""ai_agents:update""ai_agents:delete"
Example: ["campaigns:create"]
curl -i -X POST \
  https://api.instantly.ai/api/v2/api-keys \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "My API Key",
    "scopes": [
      "campaigns:create"
    ]
  }'

Responses

The API Key

Bodyapplication/json
idstring(uuid)read-onlyrequired
Example: "019affad-22ef-7734-841f-87e02240cc76"
namestringrequired
Example: "My API Key"
scopesArray of stringsrequired
Items Enum"all:all""all:create""all:read""all:update""all:delete""ai_agents:all""ai_agents:create""ai_agents:read""ai_agents:update""ai_agents:delete"
Example: ["campaigns:create"]
keystringread-onlyrequired
Example: "a1b2c3d4e5f6g7h8i9j0"
organization_idstring(uuid)read-onlyrequired
Example: "019affad-22f7-7579-9c92-89a3c4e07a85"
timestamp_createdstring(date-time)read-onlyrequired
Example: "2025-12-08T20:35:28.119Z"
timestamp_updatedstring(date-time)read-onlyrequired
Example: "2025-12-08T20:35:28.119Z"
Response
application/json
{
  "id": "019affad-22ef-7734-841f-87e02240cc76",
  "name": "My API Key",
  "scopes": [
    "campaigns:create"
  ],
  "key": "a1b2c3d4e5f6g7h8i9j0",
  "organization_id": "019affad-22f7-7579-9c92-89a3c4e07a85",
  "timestamp_created": "2025-12-08T20:35:28.119Z",
  "timestamp_updated": "2025-12-08T20:35:28.119Z"
}

List api key

Request

Requires one of the following scopes: api_keys:read, api_keys:all, all:read, all:all

Query
limitinteger[ 1 .. 100 ]

The number of items to return

Example: limit=10
starting_afterstring

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.

Example: starting_after=01956fbd-0eb1-72db-a565-82977a586084
curl -i -X GET \
  'https://api.instantly.ai/api/v2/api-keys?limit=10&starting_after=01956fbd-0eb1-72db-a565-82977a586084' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The list of API Key

Bodyapplication/json
itemsArray of objects(API Key)required

The list of API Key

items[].​idstring(uuid)read-onlyrequired
Example: "019affad-22ef-7734-841f-87e02240cc76"
items[].​namestringrequired
Example: "My API Key"
items[].​scopesArray of stringsrequired
Items Enum"all:all""all:create""all:read""all:update""all:delete""ai_agents:all""ai_agents:create""ai_agents:read""ai_agents:update""ai_agents:delete"
Example: ["campaigns:create"]
items[].​keystringread-onlyrequired
Example: "a1b2c3d4e5f6g7h8i9j0"
items[].​organization_idstring(uuid)read-onlyrequired
Example: "019affad-22f7-7579-9c92-89a3c4e07a85"
items[].​timestamp_createdstring(date-time)read-onlyrequired
Example: "2025-12-08T20:35:28.119Z"
items[].​timestamp_updatedstring(date-time)read-onlyrequired
Example: "2025-12-08T20:35:28.119Z"
next_starting_afterstring

The filter for getting the next items after this one, this could either be a UUID, a timestamp, on an email depending on the specific API

Example: "019affad-3e47-7ecd-ad22-496a7ed94dd4"
Response
application/json
{
  "items": [
    { … }
  ],
  "next_starting_after": "019affad-3e47-7ecd-ad22-496a7ed94dd4"
}

Delete api key

Request

Requires one of the following scopes: api_keys:delete, api_keys:all, all:delete, all:all

Path
idstring(uuid)required

The ID of the item to delete

Example: 019affad-3e48-7926-a1fb-46319427d37f
Bodyapplication/json
null
curl -i -X DELETE \
  https://api.instantly.ai/api/v2/api-keys/019affad-3e48-7926-a1fb-46319427d37f \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json'

Responses

The deleted API Key

Bodyapplication/json
idstring(uuid)read-onlyrequired
Example: "019affad-22ef-7734-841f-87e02240cc76"
namestringrequired
Example: "My API Key"
scopesArray of stringsrequired
Items Enum"all:all""all:create""all:read""all:update""all:delete""ai_agents:all""ai_agents:create""ai_agents:read""ai_agents:update""ai_agents:delete"
Example: ["campaigns:create"]
keystringread-onlyrequired
Example: "a1b2c3d4e5f6g7h8i9j0"
organization_idstring(uuid)read-onlyrequired
Example: "019affad-22f7-7579-9c92-89a3c4e07a85"
timestamp_createdstring(date-time)read-onlyrequired
Example: "2025-12-08T20:35:28.119Z"
timestamp_updatedstring(date-time)read-onlyrequired
Example: "2025-12-08T20:35:28.119Z"
Response
application/json
{
  "id": "019affad-22ef-7734-841f-87e02240cc76",
  "name": "My API Key",
  "scopes": [
    "campaigns:create"
  ],
  "key": "a1b2c3d4e5f6g7h8i9j0",
  "organization_id": "019affad-22f7-7579-9c92-89a3c4e07a85",
  "timestamp_created": "2025-12-08T20:35:28.119Z",
  "timestamp_updated": "2025-12-08T20:35:28.119Z"
}

Account Campaign Mapping

Account Campaign Mapping

Operations

Lead

A lead entity representing an individual lead

Operations

Background Job

A background job that can be used to perform long-running tasks

Operations

Custom Tag

A custom tag for organizing and categorizing accounts and campaigns. You can use them as filters in apis that list accounts and campaigns.

Operations

Custom Tag Mapping

This entity represents a tag being assigned to a specific campaign or email account. When an email account is assigned a tag, a new custom tag mapping entry is created, which connects the tag (tag_id field) with the email account (resource_id field). You can use it to see which tag si connected to which resource.

Operations

Block List Entry

A blocked email or domain

Operations

Lead Label

A custom label for categorizing and managing leads

Operations

Workspace

A workspace entity representing a workspace

Operations

SuperSearch Enrichment

An enrichment can take different forms, such as email enrichment or LinkedIn enrichment. Leads may be imported from SuperSearch using the dedicated endpoint, or enriched directly within a list or campaign by attaching an enrichment to it.

Operations

Workspace Group Member

A member of a workspace group. You can use the endpoints within this entity to manage the members of a workspace group.

Operations

Workspace Member

A member of a workspace with associated user details

Operations

Campaign Subsequence

A subsequence entity representing a follow-up sequence

Operations

Audit Log

Audit log records for tracking system activities

Operations

Webhook

A webhook subscription for receiving event notifications

Operations

Webhook Event

A webhook event that was sent or attempted to be sent

Operations

DFY Email Account Order

A Done-For-You email account order

Operations

Custom Prompt Template

Custom prompt templates for creating custom prompts

Sales Flow

Manages how sales users view and interact with campaign and lead lists within the sales flow.

Email Template

A campaign email template

Workspace Billing

Workspace Billing

Operations

CRM Actions

CRM related actions

Operations

Schemas