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

Get daily campaign analytics

Request

Get campaign daily analytics

Query
campaign_idstring(uuid)

Campaign ID (optional). Leave this field empty to get the analytics for all campaigns

Example: campaign_id=019942fb-7278-768d-8148-8d9c7134a014
start_datestring

Start date

Example: start_date=2024-01-01
end_datestring

End date

Example: end_date=2024-01-01
campaign_statusnumber

Filter by campaign status (only the analytics for the campaigns with the specified status will be returned)

Enum ValueDescription
0

Draft

1

Active

2

Paused

3

Completed

4

Running Subsequences

-99

Account Suspended

-1

Accounts Unhealthy

-2

Bounce Protect

Example: campaign_status=1
curl -i -X GET \
  'https://api.instantly.ai/api/v2/campaigns/analytics/daily?campaign_id=019942fb-7278-768d-8148-8d9c7134a014&campaign_status=1&end_date=2024-01-01&start_date=2024-01-01' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Default Response

Bodyapplication/jsonArray [
datestring

The date of the analytics entry, in YYYY-MM-DD format

Example: "2025-03-01"
sentinteger

The total number of sent emails

Example: 5421
openedinteger

The total number of opened emails

Example: 99
unique_openedinteger

The total number of unique opened emails

Example: 60
repliesinteger

The total number of replies

Example: 60
unique_repliesinteger

The total number of unique replies

Example: 60
clicksinteger

The total number of links clicked

Example: 60
unique_clicksinteger

The total number of unique links clicked. Unique meaning from unique leads, not unique links. For instance, if a lead clicked a link 3 times, it will be counted as 1 unique click. If a lead clicked 3 different links, it will still be counted as 1 unique click

Example: 60
]
Response
application/json
[ { "date": "2025-03-01", "sent": 5421, "opened": 99, "unique_opened": 60, "replies": 60, "unique_replies": 60, "clicks": 60, "unique_clicks": 60 } ]

Get campaign steps analytics

Request

Get campaign steps analytics

Query
campaign_idstring(uuid)

Campaign ID (optional). Leave this field empty to get the analytics for all campaigns

Example: campaign_id=019942fb-7279-7d0f-9a27-382be6510e84
start_datestring

Start date

Example: start_date=2024-01-01
end_datestring

End date

Example: end_date=2024-01-01
curl -i -X GET \
  'https://api.instantly.ai/api/v2/campaigns/analytics/steps?campaign_id=019942fb-7279-7d0f-9a27-382be6510e84&end_date=2024-01-01&start_date=2024-01-01' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Default Response

Bodyapplication/jsonArray [
stepstring

The step number

Example: "1"
variantstring

The variant number, starting from 0. 0 = A, 1 = B, 2 = C, etc.

Example: "0"
sentinteger

The total number of sent emails

Example: 5421
openedinteger

The total number of opened emails

Example: 99
unique_openedinteger

The total number of opened emails

Example: 60
repliesinteger

The total number of replies

Example: 60
unique_repliesinteger

The total number of replies

Example: 60
clicksinteger

The total number of links clicked

Example: 60
unique_clicksinteger

The total number of unique links clicked. Unique meaning from unique leads, not unique links. For instance, if a lead clicked a link 3 times, it will be counted as 1 unique click. If a lead clicked 3 different links, it will still be counted as 1 unique click

Example: 60
]
Response
application/json
[ { "step": "1", "variant": "0", "sent": 5421, "opened": 99, "unique_opened": 60, "replies": 60, "unique_replies": 60, "clicks": 60, "unique_clicks": 60 } ]

Share a campaign

Request

Share a campaign. This allows other users to create new campaigns based on this campaign. The campaign is being shared for 7 days, after which you'll have to call this endpoint again if you want to enable sharing on the campaign

Path
idstring(uuid)required

Campaign ID

Example: 019942fb-727b-7e22-a39d-c7b1d981467c
curl -i -X POST \
  https://api.instantly.ai/api/v2/campaigns/019942fb-727b-7e22-a39d-c7b1d981467c/share \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Default Response

Bodyapplication/json
any
Response
application/json
null

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

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

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

A SuperSearch enrichment that retrieves and enriches leads based on search filters

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

Clause

A clause (filter or sort) that can be applied to variables in campaigns or lists

Audit Log

Audit log records for tracking system activities

Operations

Webhook

A webhook subscription for receiving event notifications

Operations

Schemas