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.

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

Operations

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

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

Schemas

Account

An email account that can be used to send campaigns

emailstring(email)required

Email address of the account

Example: "user@example.com"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the account was created

Example: "2025-06-12T13:28:54.047Z"

timestamp_updatedstring(date-time)read-onlyrequired

Timestamp when the account was last updated

Example: "2025-06-12T13:28:54.047Z"

first_namestringrequired

First name associated with the account

Example: "John"

last_namestringrequired

Last name associated with the account

Example: "Doe"

organizationstring(uuid)read-onlyrequired

Organization ID that owns this account

Example: "01976454-461f-70c5-a406-bbab3b8ed5ea"

warmup_statusnumberread-onlyrequired

Current warmup status of the account

Enum Value	Description
0	Paused
1	Active
-1	Banned
-2	Spam Folder Unknown
-3	Permanent Suspension

Example: 1

provider_codenumberrequired

Provider code for the account. Please make sure to specify the right provider code, otherwise your account will not work.

Enum Value	Description
1	Custom IMAP/SMTP
2	Google
3	Microsoft
4	AWS

Example: 2

setup_pendingbooleanread-onlyrequired

Whether account setup is pending

Example: false

is_managed_accountbooleanread-onlyrequired

Whether this is a managed account

Example: false

warmupobject

Warmup configuration for the account

added_bynull or string(uuid)read-only

User ID who added the account

Example: "01976454-461f-70c5-a406-bba901fa7c30"

daily_limitnull or number

Daily email sending limit

Example: 100

modified_bynull or string(uuid)read-only

User ID who last modified the account

Example: "01976454-461f-70c5-a406-bbaa1aacae5b"

tracking_domain_namenull or string

Tracking domain

Example: "example.com"

tracking_domain_statusnull or string

Tracking domain status

Example: "active"

statusnumberread-only

Current status of the account

Enum Value	Description
1	Active
2	Paused
-1	Connection Error
-2	Soft Bounce Error
-3	Sending Error

Example: 1

enable_slow_rampnull or boolean

Whether to enable slow ramp up for sending limits

Example: false

inbox_placement_test_limitnull or number

The limit for inbox placement tests

Example: 10

timestamp_last_usednull or string(date-time)read-only

Timestamp when the account was last used

Example: "2025-06-12T13:28:54.047Z"

status_messageobjectread-only

Status message for the account

timestamp_warmup_startnull or string(date-time)read-only

Timestamp when warmup was started

Example: "2025-06-12T13:28:54.047Z"

warmup_pool_idnull or string(uuid)read-only

ID of the warmup pool this account belongs to

Example: "01976454-461f-70c5-a406-bbacdc457f16"

dfy_password_changednull or booleanread-only

Whether DFY password has been changed

Example: false

stat_warmup_scorenull or numberread-only

Warmup score for the account

Example: 85

sending_gapnumber[ 0 .. 1440 ]

The gap between emails sent from this account in minutes (minimum wait time when used with multiple campaigns)

Example: 10

{
  "email": "user@example.com",
  "timestamp_created": "2025-06-12T13:28:54.047Z",
  "timestamp_updated": "2025-06-12T13:28:54.047Z",
  "first_name": "John",
  "last_name": "Doe",
  "warmup": {
    "limit": 100,
    "advanced": { … },
    "warmup_custom_ftag": "warmup",
    "increment": "disabled",
    "reply_rate": 0.1
  },
  "added_by": "01976454-461f-70c5-a406-bba901fa7c30",
  "daily_limit": 100,
  "modified_by": "01976454-461f-70c5-a406-bbaa1aacae5b",
  "tracking_domain_name": "example.com",
  "tracking_domain_status": "active",
  "status": 1,
  "enable_slow_ramp": false,
  "inbox_placement_test_limit": 10,
  "organization": "01976454-461f-70c5-a406-bbab3b8ed5ea",
  "timestamp_last_used": "2025-06-12T13:28:54.047Z",
  "warmup_status": 1,
  "status_message": {
    "code": "EENVELOPE",
    "command": "DATA",
    "response": "550-5.4.5 Daily user sending limit exceeded. For more information on Gmai",
    "e_message": "error: data command failed: 550-5.4.5 daily user sending limit exceeded",
    "responseCode": 550
  },
  "timestamp_warmup_start": "2025-06-12T13:28:54.047Z",
  "provider_code": 2,
  "setup_pending": false,
  "warmup_pool_id": "01976454-461f-70c5-a406-bbacdc457f16",
  "is_managed_account": false,
  "dfy_password_changed": false,
  "stat_warmup_score": 85,
  "sending_gap": 10
}

Campaign

A campaign that can be sent to a list of recipients

idstring(uuid)read-onlyrequired

Unique identifier for the campaign

Example: "01976454-45f1-792b-a247-b6790db79e1e"

namestringrequired

Name of the campaign

Example: "My First Campaign"

statusnumberread-onlyrequired

Campaign Status

Enum Value	Description
0	Draft
1	Active
2	Paused
3	Completed
4	Running Subsequences
-99	Account Suspended
-1	Accounts Unhealthy
-2	Bounce Protect

Example: 1

campaign_scheduleobjectrequired

Campaign schedule

campaign_schedule.schedulesArray of objectsnon-emptyrequired

campaign_schedule.schedules[].namestringrequired

Example: "My Schedule"

campaign_schedule.schedules[].timingobjectrequired

campaign_schedule.schedules[].timing.fromstring^([01][0-9]|2[0-3]):([0-5][0-9])$required

Example: "09:00"

campaign_schedule.schedules[].timing.tostring^([01][0-9]|2[0-3]):([0-5][0-9])$required

Example: "17:00"

campaign_schedule.schedules[].daysobjectnon-emptyrequired

campaign_schedule.schedules[].days.0boolean

Example: true

campaign_schedule.schedules[].days.1boolean

Example: true

campaign_schedule.schedules[].days.2boolean

Example: true

campaign_schedule.schedules[].days.3boolean

Example: true

campaign_schedule.schedules[].days.4boolean

Example: true

campaign_schedule.schedules[].days.5boolean

Example: false

campaign_schedule.schedules[].days.6boolean

Example: false

campaign_schedule.schedules[].timezonestringrequired

Enum"Etc/GMT+12""Etc/GMT+11""Etc/GMT+10""America/Anchorage""America/Dawson""America/Creston""America/Chihuahua""America/Boise""America/Belize""America/Chicago"

Example: "Etc/GMT+12"

campaign_schedule.start_datestring(date-time)

Example: "2025-06-12T13:28:54.001Z"

campaign_schedule.end_datestring(date-time)

Example: "2025-06-12T13:28:54.001Z"

timestamp_createdstringread-onlyrequired

Timestamp when the campaign was created

Example: "2025-06-12T13:28:54.001Z"

timestamp_updatedstringread-onlyrequired

Timestamp when the campaign was last updated

Example: "2025-06-12T13:28:54.001Z"

pl_valuenull or number

Value of every positive lead

Example: 100

is_evergreennull or boolean

Whether the campaign is evergreen

Example: false

sequencesArray of objects

List of sequences (the actual email copy). Even though this field is an array, only the first element is used, so please provide only one array item, and add the steps to that array

email_gapnull or number

The gap between emails in minutes

Example: 10

random_wait_maxnull or number

The maximum random wait time in minutes

Example: 10

text_onlynull or boolean

Whether the campaign is text only

Example: false

email_listArray of strings

List of accounts to use for sending emails

Example: ["john@doe.com"]

daily_limitnull or number

The daily limit for sending emails

Example: 100

stop_on_replynull or boolean

Whether to stop the campaign on reply

Example: false

email_tag_listArray of strings(uuid)

List of tags to use for sending emails

Example: ["01976454-45f1-792b-a247-b67a62ab4edf"]

link_trackingnull or boolean

Whether to track links in emails

Example: true

open_trackingnull or boolean

Whether to track opens in emails

Example: true

stop_on_auto_replynull or boolean

Whether to stop the campaign on auto reply

Example: false

daily_max_leadsnull or number

The daily maximum new leads to contact

Example: 100

prioritize_new_leadsnull or boolean

Whether to prioritize new leads

Example: false

auto_variant_selectobject

Auto variant select settings

match_lead_espnull or boolean

Whether to match leads by ESP

Example: false

stop_for_companynull or boolean

Whether to stop the campaign for the entire company(domain) when a lead replies

Example: false

insert_unsubscribe_headernull or boolean

Whether to insert an unsubscribe header in emails

Example: false

allow_risky_contactsnull or boolean

Whether to allow risky contacts

Example: false

disable_bounce_protectnull or boolean

Whether to disable bounce protection

Example: false

cc_listArray of strings(email)

List of accounts to CC on emails

Example: ["john@doe.com"]

bcc_listArray of strings(email)

List of accounts to BCC on emails

Example: ["john@doe.com"]

organizationnull or string(uuid)read-only

Organization ID

Example: "01976454-45f1-792b-a247-b67bd2c6cfeb"

{
  "id": "01976454-45f1-792b-a247-b6790db79e1e",
  "name": "My First Campaign",
  "pl_value": 100,
  "status": 1,
  "is_evergreen": false,
  "campaign_schedule": {
    "start_date": "2025-06-12T13:28:54.001Z",
    "end_date": "2025-06-12T13:28:54.001Z",
    "schedules": [ … ]
  },
  "sequences": [
    { … }
  ],
  "timestamp_created": "2025-06-12T13:28:54.001Z",
  "timestamp_updated": "2025-06-12T13:28:54.001Z",
  "email_gap": 10,
  "random_wait_max": 10,
  "text_only": false,
  "email_list": [
    "john@doe.com"
  ],
  "daily_limit": 100,
  "stop_on_reply": false,
  "email_tag_list": [
    "01976454-45f1-792b-a247-b67a62ab4edf"
  ],
  "link_tracking": true,
  "open_tracking": true,
  "stop_on_auto_reply": false,
  "daily_max_leads": 100,
  "prioritize_new_leads": false,
  "auto_variant_select": {
    "trigger": "click_rate"
  },
  "match_lead_esp": false,
  "stop_for_company": false,
  "insert_unsubscribe_header": false,
  "allow_risky_contacts": false,
  "disable_bounce_protect": false,
  "cc_list": [
    "john@doe.com"
  ],
  "bcc_list": [
    "john@doe.com"
  ],
  "organization": "01976454-45f1-792b-a247-b67bd2c6cfeb"
}

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: "01976454-4628-780c-b29f-f465b029b758"

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-06-12T13:28:54.056Z"

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-06-12T13:28:54.056Z"

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: "01976454-4628-780c-b29f-f466965efa5a"

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_emailnull or string(email)read-only

The sender email address, populated based on the eaccount

Example: "sender@example.com"

cc_address_email_listnull or string

Comma-separated list of CC email addresses

Example: "cc@example.com"

bcc_address_email_listnull or string

Comma-separated list of BCC email addresses

Example: "bcc@example.com"

reply_tonull or string

Reply-to email address

Example: "replyto@example.com"

campaign_idnull or string(uuid)

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

Example: "01976454-4628-780c-b29f-f467f628eb23"

subsequence_idnull or string(uuid)

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

Example: "01976454-4629-7dc7-99dd-5451b348a6b4"

list_idnull or string(uuid)

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

Example: "01976454-4629-7dc7-99dd-5452224667ff"

leadnull or string

The email address of the lead that the email is associated with

Example: "jondoe@example.com"

lead_idnull or string(uuid)

The lead id (if any)

Example: "01976454-4629-7dc7-99dd-54539a7ca87a"

ue_typenull or number

Email type based on the life cycle of the email

Enum Value	Description
1	Sent from campaign
2	Received
3	Sent
4	Scheduled

Example: 3

stepnull or string

The campaign step that the email is associated with

Example: "step-123"

is_unreadnull or number

Indicates if the email is unread

Example: 1

is_auto_replynull or numberread-only

Indicates if the email is an auto-reply. 0 (zero) - is false, and 1 is true

Example: 0

reminder_tsnull or string(date-time)

Timestamp for the reminder.

Example: "2025-06-12T13:28:54.057Z"

ai_interest_valuenull or number

AI interest value

Example: 0.75

ai_assistednull or number

Indicates if AI assistance was used

Example: 1

is_focusednull or number

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

Example: 1

i_statusnull or number

Indicates the interest status of the email

Example: 0

thread_idnull or string(uuid)

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

Example: "01976454-4629-7dc7-99dd-545465aae916"

content_previewnull or string

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 null or arrays or null

List of from address details

to_address_jsonArray of null or arrays or null

List of to address details

cc_address_jsonArray of null or arrays or null

List of CC address details

{
  "id": "01976454-4628-780c-b29f-f465b029b758",
  "timestamp_created": "2025-06-12T13:28:54.056Z",
  "timestamp_email": "2025-06-12T13:28:54.056Z",
  "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": "01976454-4628-780c-b29f-f466965efa5a",
  "campaign_id": "01976454-4628-780c-b29f-f467f628eb23",
  "subsequence_id": "01976454-4629-7dc7-99dd-5451b348a6b4",
  "list_id": "01976454-4629-7dc7-99dd-5452224667ff",
  "lead": "jondoe@example.com",
  "lead_id": "01976454-4629-7dc7-99dd-54539a7ca87a",
  "eaccount": "eaccount-123",
  "ue_type": 3,
  "step": "step-123",
  "is_unread": 1,
  "is_auto_reply": 0,
  "reminder_ts": "2025-06-12T13:28:54.057Z",
  "ai_interest_value": 0.75,
  "ai_assisted": 1,
  "is_focused": 1,
  "i_status": 0,
  "thread_id": "01976454-4629-7dc7-99dd-545465aae916",
  "content_preview": "This is a preview of the email content.",
  "from_address_json": null,
  "to_address_json": null,
  "cc_address_json": null
}