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

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

Schemas

Email Verification

A single email verification

emailstringrequired

The email address to verify

Example: "example@example.com"
verification_statusstringread-onlyrequired

The verification status.

Enum ValueDescription
pending

The verification is pending

verified

The verification is verified

invalid

The verification is invalid

Example: "pending"
statusnull or stringread-only

The request status. Do not use this field to determine the verification status. Please use verification_status instead to check the verification status

Enum ValueDescription
success

The verification was successful

error

The verification was unsuccessful

Example: "success"
catch_allboolean or stringread-only

Whether this is a catch-all email address

Enum ValueDescription
false

The email is not a catch-all

true

The email is a catch-all

pending

The catch-all status is pending

Example: true
creditsnull or numberread-only

The number of verification credits available after the verification

Example: 100
credits_usednull or numberread-only

The number of verification credits used

Example: 1
{ "status": "success", "email": "example@example.com", "verification_status": "pending", "catch_all": true, "credits": 100, "credits_used": 1 }

Lead List

A list used to store leads

idstring(uuid)read-onlyrequired

Unique identifier for the lead list

Example: "019a0b42-e5b5-749b-a5fe-3ee615f36f3e"
organization_idstring(uuid)read-onlyrequired

Organization ID that owns this lead list

Example: "019a0b42-e5b5-749b-a5fe-3ee72c92aeae"
namestringrequired

Name of the lead list

Example: "My Lead List"
timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the lead list was created

Example: "2025-10-22T09:32:04.917Z"
has_enrichment_tasknull or boolean

Whether this list runs the enrichment process on every added lead or not

Example: false
owned_bynull or string(uuid)

User ID of the owner of this lead list. Defaults to the user that created the list

Example: "019a0b42-e5b5-749b-a5fe-3ee88613950b"
{ "id": "019a0b42-e5b5-749b-a5fe-3ee615f36f3e", "organization_id": "019a0b42-e5b5-749b-a5fe-3ee72c92aeae", "has_enrichment_task": false, "owned_by": "019a0b42-e5b5-749b-a5fe-3ee88613950b", "name": "My Lead List", "timestamp_created": "2025-10-22T09:32:04.917Z" }

Inbox Placement Test

An inbox placement test

idstring(uuid)read-onlyrequired

Unique identifier for the inbox placement test

Example: "019a0b42-e5ac-71d6-8b40-01dfab6c4876"
organization_idstring(uuid)read-onlyrequired

Organization ID

Example: "019a0b42-e5ac-71d6-8b40-01e03d3df850"
namestringrequired

Name of the inbox placement test

Example: "My Inbox Placement Test"
typenumberrequired

Whether the inbox placement test is a one-time test or an automated test

Enum12
Example: 1
sending_methodnumberrequired

Whether the inbox placement test will be sent from Instantly or from outside Instantly

Enum ValueDescription
1

From Instantly

2

From Outside Instantly

Example: 1
email_subjectstringrequired

Email subject of the inbox placement test

Example: "My Email Subject"
email_bodystringrequired

Email body of the inbox placement test

Example: "Hi, this is my email body"
emailsArray of stringsrequired

Emails to send the inbox placement test to

Example: ["john@doe.com"]
recipientsArray of stringsread-onlyrequired
Example: ["johndoe@instantly.ai"]
timestamp_createdstringread-onlyrequired

Timestamp when the inbox placement test was created

Example: "2025-10-22T09:32:04.909Z"
delivery_modenull or number

Whether to send emails one by one or all together

Enum ValueDescription
1

One by one

2

All together

Example: 1
descriptionnull or string

Description of the inbox placement test

Example: "This is a test description"
scheduleobject

Specifies the date and time when the automated inbox placement tests will be sent.

Example: {"days":{"2":true,"3":true},"timing":{"from":"02:30"},"timezone":"America/Chihuahua"}
campaign_idnull or string(uuid)

Campaign ID

Example: "019a0b42-e5ad-7eab-83e3-d6327e483113"
test_codenull or string

Code for identifying the inbox placement tests in the email body from outside Instantly

Example: "ptid__7iNi0rb7GTe4eOsbmNFh"
tagsArray of strings or null(uuid)

List of tag IDs to use for sending emails

text_onlynull or boolean

Disables open tracking

Example: true
recipients_labelsArray of objects

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

timestamp_next_runnull or string

Timestamp when the inbox placement test will run next

Example: "2025-10-22T09:32:04.909Z"
automationsArray of objects or null>= 0 items

Optional automations to trigger based on conditions

statusnull or number

Status of the inbox placement test

Enum ValueDescription
1

Active

2

Paused

3

Completed

Example: 1
not_sending_statusnull or string

Why the inbox placement test is currently not sending. It will be an empty string if there are no issues.

Enum ValueDescription
daily_limits_hit

Daily limits hit

other

Other reason

Example: "daily_limits_hit"
{ "id": "019a0b42-e5ac-71d6-8b40-01dfab6c4876", "organization_id": "019a0b42-e5ac-71d6-8b40-01e03d3df850", "name": "My Inbox Placement Test", "delivery_mode": 1, "description": "This is a test description", "schedule": { "days": {}, "timing": {}, "timezone": "America/Chihuahua" }, "type": 1, "sending_method": 1, "campaign_id": "019a0b42-e5ad-7eab-83e3-d6327e483113", "email_subject": "My Email Subject", "email_body": "Hi, this is my email body", "emails": [ "john@doe.com" ], "test_code": "ptid__7iNi0rb7GTe4eOsbmNFh", "tags": null, "text_only": true, "recipients": [ "johndoe@instantly.ai" ], "recipients_labels": [ {} ], "timestamp_created": "2025-10-22T09:32:04.909Z", "timestamp_next_run": "2025-10-22T09:32:04.909Z", "automations": null, "status": 1, "not_sending_status": "daily_limits_hit" }