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=019a5522-8616-790c-833f-2c9f405f6363
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=019a5522-8616-790c-833f-2c9f405f6363&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
opportunitiesinteger

The total number of unique opportunities created from the campaign on that day

Example: 5
unique_opportunitiesinteger

The total number of unique opportunities created from unique leads from the campaign on that day

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

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=019a5522-8616-790c-833f-2ca0cdbcc6e3
start_datestring

Start date

Example: start_date=2024-01-01
end_datestring

End date

Example: end_date=2024-01-01
include_opportunities_countboolean

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

Default false
Example: include_opportunities_count=true
curl -i -X GET \
  'https://api.instantly.ai/api/v2/campaigns/analytics/steps?campaign_id=019a5522-8616-790c-833f-2ca0cdbcc6e3&end_date=2024-01-01&include_opportunities_count=true&start_date=2024-01-01' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Default Response

Bodyapplication/jsonArray [
stepnull or stringrequired

The step number. When null it means we couldn't determine the step number for the event, for instance for list leads, which are not part of a campaign.

Example: "1"
variantnull or stringrequired

The variant number, starting from 0. 0 = A, 1 = B, 2 = C, etc. When null it means we couldn't determine the variant for the event.

Example: "0"
sentintegerrequired

The total number of sent emails

Example: 5421
openedintegerrequired

The total number of opened emails

Example: 99
unique_openedintegerrequired

The total number of opened emails

Example: 60
repliesintegerrequired

The total number of replies

Example: 60
unique_repliesintegerrequired

The total number of replies

Example: 60
clicksintegerrequired

The total number of links clicked

Example: 60
unique_clicksintegerrequired

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
opportunitiesinteger

The total number of opportunities created from this step. Included only if include_opportunities_count is true

Example: 10
unique_opportunitiesinteger

The total number of unique opportunities created from this step. Unique meaning unique per lead. If a lead has multiple opportunities, it will be counted as 1 unique opportunity. Included only if include_opportunities_count is true

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

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: 019a5522-8618-7eab-80a8-9a98101654b9
curl -i -X POST \
  https://api.instantly.ai/api/v2/campaigns/019a5522-8618-7eab-80a8-9a98101654b9/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

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

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

Schemas