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 items

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

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

Schemas

Email

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

idstring(uuid)read-onlyrequired

A Unique identifier

Example: "01959271-1f7f-7d76-8a8f-286834e2ee38"
timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the email was added to our database. This is not the timestamp of the email itself, since the email could have been sent at a different time. Please check the timestamp_email field for the timestamp of the email.

Example: "2025-03-14T02:17:22.047Z"
timestamp_emailstring(date-time)read-onlyrequired

The timestamp of the email, as provided by the email server. Please note that the timestamp is not always accurate, as it can be manipulated by the sender or the email server.

Example: "2025-03-14T02:17:22.047Z"
message_idstringread-onlyrequired

Unique email ID from the email server

Example: "<example123@mail.gmail.com>"
subjectstringrequired

Subject line of the email message

Example: "Re: Your inquiry"
to_address_email_liststringrequired

Comma-separated list of recipient email addresses

Example: "recipient@example.com"
bodyobjectread-onlyrequired

An object containing the email body in HTML and text format

body.​textstring

Text content of the email

Example: "This is a test email"
body.​htmlstring

HTML content of the email

Example: "<p>This is a test email</p>"
organization_idstring(uuid)read-onlyrequired

The workspace ID

Example: "01959271-1f7f-7d76-8a8f-2869119acdf6"
eaccountstringrequired

The email account that was used to send the email. This needs to be validated to make sure it exists in the user workspace

Example: "eaccount-123"
from_address_emailstring(email)read-only

The sender email address, populated based on the eaccount

Example: "sender@example.com"
cc_address_email_liststring

Comma-separated list of CC email addresses

Example: "cc@example.com"
bcc_address_email_liststring

Comma-separated list of BCC email addresses

Example: "bcc@example.com"
reply_tostring

Reply-to email address

Example: "replyto@example.com"
campaign_idstring(uuid)

The id of the campaign that the email is associated with (it can be null for manually sent emails)

Example: "01959271-1f7f-7d76-8a8f-286ada9833bd"
subsequence_idstring(uuid)

The id of the campaign subsequence that the email is associated with (it can be null for manually sent emails)

Example: "01959271-1f7f-7d76-8a8f-286bbb2b2346"
list_idstring(uuid)

The id of the list (if the lead is part of a list)

Example: "01959271-1f7f-7d76-8a8f-286cd99afd33"
leadstring(uuid)

The lead id (if any)

Example: "01959271-1f7f-7d76-8a8f-286d1e5745c5"
ue_typenumber

Email type based on the life cycle of the email

Enum ValueDescription
1

Sent from campaign

2

Received

3

Sent

4

Scheduled

Example: 3
stepstring

The campaign step that the email is associated with

Example: "step-123"
is_unreadboolean

Indicates if the email is unread

Example: true
is_auto_replyboolean

Indicates if the email is an auto-reply

Example: false
reminder_tsstring(date-time)

Timestamp for the reminder.

Example: "2025-03-14T02:17:22.047Z"
ai_interest_valuenumber

AI interest value

Example: 0.75
ai_assistednumber

Indicates if AI assistance was used

Example: 1
is_focusednumber

Indicates if the email is focused (is in the primary tab in the Unibox)

Example: 1
i_statusnumber

Indicates the interest status of the email

Example: 0
thread_idstring(uuid)

Identifier for the email thread. All the emails in the same thread have the same thread ID

Example: "01959271-1f7f-7d76-8a8f-286ef545e568"
content_previewstring

A short preview of the email content (usually the first few lines of the email)

Example: "This is a preview of the email content."
from_address_jsonArray of arrays

List of from address details

to_address_jsonArray of arrays

List of to address details

cc_address_jsonArray of arrays

List of CC address details

{ "id": "01959271-1f7f-7d76-8a8f-286834e2ee38", "timestamp_created": "2025-03-14T02:17:22.047Z", "timestamp_email": "2025-03-14T02:17:22.047Z", "message_id": "<example123@mail.gmail.com>", "subject": "Re: Your inquiry", "from_address_email": "sender@example.com", "to_address_email_list": "recipient@example.com", "cc_address_email_list": "cc@example.com", "bcc_address_email_list": "bcc@example.com", "reply_to": "replyto@example.com", "body": { "text": "This is a test email", "html": "<p>This is a test email</p>" }, "organization_id": "01959271-1f7f-7d76-8a8f-2869119acdf6", "campaign_id": "01959271-1f7f-7d76-8a8f-286ada9833bd", "subsequence_id": "01959271-1f7f-7d76-8a8f-286bbb2b2346", "list_id": "01959271-1f7f-7d76-8a8f-286cd99afd33", "lead": "01959271-1f7f-7d76-8a8f-286d1e5745c5", "eaccount": "eaccount-123", "ue_type": 3, "step": "step-123", "is_unread": true, "is_auto_reply": false, "reminder_ts": "2025-03-14T02:17:22.047Z", "ai_interest_value": 0.75, "ai_assisted": 1, "is_focused": 1, "i_status": 0, "thread_id": "01959271-1f7f-7d76-8a8f-286ef545e568", "content_preview": "This is a preview of the email content.", "from_address_json": [], "to_address_json": [], "cc_address_json": [] }

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"
statusstringread-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
creditsnumberread-only

The number of verification credits available after the verification

Example: 100
credits_usednumberread-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: "01959271-1f75-702a-99d0-46734eb868ef"
organization_idstring(uuid)read-onlyrequired

Organization ID that owns this lead list

Example: "01959271-1f75-702a-99d0-4674354394db"
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-03-14T02:17:22.037Z"
has_enrichment_taskboolean

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

Example: false
owned_bystring(uuid)

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

Example: "01959271-1f75-702a-99d0-46753cb39fa6"
{ "id": "01959271-1f75-702a-99d0-46734eb868ef", "organization_id": "01959271-1f75-702a-99d0-4674354394db", "has_enrichment_task": false, "owned_by": "01959271-1f75-702a-99d0-46753cb39fa6", "name": "My Lead List", "timestamp_created": "2025-03-14T02:17:22.037Z" }