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

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-03-14T02:17:21.080Z"

timestamp_updatedstring(date-time)read-onlyrequired

Timestamp when the account was last updated

Example: "2025-03-14T02:17:21.080Z"

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: "01959271-1bb8-760e-a18e-24e3bee4230f"

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_bystring(uuid)read-only

User ID who added the account

Example: "01959271-1bb8-760e-a18e-24e152223702"

daily_limitnumber

Daily email sending limit

Example: 100

modified_bystring(uuid)read-only

User ID who last modified the account

Example: "01959271-1bb8-760e-a18e-24e2bfa1bf42"

tracking_domain_namestring

Tracking domain

Example: "example.com"

tracking_domain_statusstring

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_rampboolean

Whether to enable slow ramp up for sending limits

Example: false

inbox_placement_test_limitboolean

Whether inbox placement test limit is enabled

Example: false

timestamp_last_usedstring(date-time)read-only

Timestamp when the account was last used

Example: "2025-03-14T02:17:21.080Z"

status_messagestringread-only

Status message for the account

Example: "Account is working normally"

timestamp_warmup_startedstring(date-time)read-only

Timestamp when warmup was started

Example: "2025-03-14T02:17:21.080Z"

warmup_pool_idstring(uuid)read-only

ID of the warmup pool this account belongs to

Example: "01959271-1bb8-760e-a18e-24e4ec02ee8a"

dfy_password_changedbooleanread-only

Whether DFY password has been changed

Example: false

stat_warmup_scorenumberread-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-03-14T02:17:21.080Z",
  "timestamp_updated": "2025-03-14T02:17:21.080Z",
  "first_name": "John",
  "last_name": "Doe",
  "warmup": {
    "limit": 100,
    "advanced": { … },
    "warmup_custom_ftag": "warmup",
    "increment": "disabled",
    "reply_rate": 0.1
  },
  "added_by": "01959271-1bb8-760e-a18e-24e152223702",
  "daily_limit": 100,
  "modified_by": "01959271-1bb8-760e-a18e-24e2bfa1bf42",
  "tracking_domain_name": "example.com",
  "tracking_domain_status": "active",
  "status": 1,
  "enable_slow_ramp": false,
  "inbox_placement_test_limit": false,
  "organization": "01959271-1bb8-760e-a18e-24e3bee4230f",
  "timestamp_last_used": "2025-03-14T02:17:21.080Z",
  "warmup_status": 1,
  "status_message": "Account is working normally",
  "timestamp_warmup_started": "2025-03-14T02:17:21.080Z",
  "provider_code": 2,
  "setup_pending": false,
  "warmup_pool_id": "01959271-1bb8-760e-a18e-24e4ec02ee8a",
  "is_managed_account": false,
  "dfy_password_changed": false,
  "stat_warmup_score": 85,
  "sending_gap": 10
}

Create account

Request

Requires one of the following scopes: accounts:create, accounts:all, all:create, all:all

Bodyapplication/jsonrequired

The Account to create

emailstring(email)required

Email address of the account

Example: "user@example.com"

first_namestringrequired

First name associated with the account

Example: "John"

last_namestringrequired

Last name associated with the account

Example: "Doe"

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

imap_usernamestringrequired

Example: "username"

imap_passwordstringrequired

Example: "password"

imap_hoststringrequired

Example: "imap.gmail.com"

imap_portnumberrequired

Example: 993

smtp_usernamestringrequired

Example: "username"

smtp_passwordstringrequired

Example: "password"

smtp_hoststringrequired

Example: "smtp.gmail.com"

smtp_portnumberrequired

Example: 587

warmupobject

Warmup configuration for the account

daily_limitnumber

Daily email sending limit

Example: 100

tracking_domain_namestring

Tracking domain

Example: "example.com"

tracking_domain_statusstring

Tracking domain status

Example: "active"

enable_slow_rampboolean

Whether to enable slow ramp up for sending limits

Example: false

inbox_placement_test_limitboolean

Whether inbox placement test limit is enabled

Example: false

sending_gapnumber[ 0 .. 1440 ]

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

Example: 10

reply_tostring

Example: "reply@example.com"

warmup_custom_ftagstring

Example: "warmup"

skip_cname_checkboolean

Example: false

curl -i -X POST \
  https://api.instantly.ai/api/v2/accounts \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "user@example.com",
    "first_name": "John",
    "last_name": "Doe",
    "provider_code": 2,
    "imap_username": "username",
    "imap_password": "password",
    "imap_host": "imap.gmail.com",
    "imap_port": 993,
    "smtp_username": "username",
    "smtp_password": "password",
    "smtp_host": "smtp.gmail.com",
    "smtp_port": 587
  }'

Responses

The Account

Bodyapplication/json

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-03-14T02:17:21.080Z"

timestamp_updatedstring(date-time)read-onlyrequired

Timestamp when the account was last updated

Example: "2025-03-14T02:17:21.080Z"

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: "01959271-1bb8-760e-a18e-24e3bee4230f"

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_bystring(uuid)read-only

User ID who added the account

Example: "01959271-1bb8-760e-a18e-24e152223702"

daily_limitnumber

Daily email sending limit

Example: 100

modified_bystring(uuid)read-only

User ID who last modified the account

Example: "01959271-1bb8-760e-a18e-24e2bfa1bf42"

tracking_domain_namestring

Tracking domain

Example: "example.com"

tracking_domain_statusstring

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_rampboolean

Whether to enable slow ramp up for sending limits

Example: false

inbox_placement_test_limitboolean

Whether inbox placement test limit is enabled

Example: false

timestamp_last_usedstring(date-time)read-only

Timestamp when the account was last used

Example: "2025-03-14T02:17:21.080Z"

status_messagestringread-only

Status message for the account

Example: "Account is working normally"

timestamp_warmup_startedstring(date-time)read-only

Timestamp when warmup was started

Example: "2025-03-14T02:17:21.080Z"

warmup_pool_idstring(uuid)read-only

ID of the warmup pool this account belongs to

Example: "01959271-1bb8-760e-a18e-24e4ec02ee8a"

dfy_password_changedbooleanread-only

Whether DFY password has been changed

Example: false

stat_warmup_scorenumberread-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

Response

application/json

{
  "email": "user@example.com",
  "timestamp_created": "2025-03-14T02:17:21.080Z",
  "timestamp_updated": "2025-03-14T02:17:21.080Z",
  "first_name": "John",
  "last_name": "Doe",
  "warmup": {
    "limit": 100,
    "advanced": { … },
    "warmup_custom_ftag": "warmup",
    "increment": "disabled",
    "reply_rate": 0.1
  },
  "added_by": "01959271-1bb8-760e-a18e-24e152223702",
  "daily_limit": 100,
  "modified_by": "01959271-1bb8-760e-a18e-24e2bfa1bf42",
  "tracking_domain_name": "example.com",
  "tracking_domain_status": "active",
  "status": 1,
  "enable_slow_ramp": false,
  "inbox_placement_test_limit": false,
  "organization": "01959271-1bb8-760e-a18e-24e3bee4230f",
  "timestamp_last_used": "2025-03-14T02:17:21.080Z",
  "warmup_status": 1,
  "status_message": "Account is working normally",
  "timestamp_warmup_started": "2025-03-14T02:17:21.080Z",
  "provider_code": 2,
  "setup_pending": false,
  "warmup_pool_id": "01959271-1bb8-760e-a18e-24e4ec02ee8a",
  "is_managed_account": false,
  "dfy_password_changed": false,
  "stat_warmup_score": 85,
  "sending_gap": 10
}

List account

Request

Requires one of the following scopes: accounts:read, accounts:all, all:read, all:all

Query

limitinteger[ 1 .. 100 ]

The number of items to return

Example: limit=10

starting_afterstring

Example: starting_after=2025-03-07T00:00:00.000Z

searchstring

Example: search=gmail.com

statusnumber

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

Example: status=1

provider_codenumber

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

Example: provider_code=2

curl -i -X GET \
  'https://api.instantly.ai/api/v2/accounts?limit=10&provider_code=2&search=gmail.com&starting_after=2025-03-07T00%3A00%3A00.000Z&status=1' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The list of Account

Bodyapplication/json

itemsArray of objects(Account)required

items[].emailstring(email)required

Email address of the account

Example: "user@example.com"

items[].timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the account was created

Example: "2025-03-14T02:17:21.080Z"

items[].timestamp_updatedstring(date-time)read-onlyrequired

Timestamp when the account was last updated

Example: "2025-03-14T02:17:21.080Z"

items[].first_namestringrequired

First name associated with the account

Example: "John"

items[].last_namestringrequired

Last name associated with the account

Example: "Doe"

items[].organizationstring(uuid)read-onlyrequired

Organization ID that owns this account

Example: "01959271-1bb8-760e-a18e-24e3bee4230f"

items[].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

items[].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

items[].setup_pendingbooleanread-onlyrequired

Whether account setup is pending

Example: false

items[].is_managed_accountbooleanread-onlyrequired

Whether this is a managed account

Example: false

items[].warmupobject

Warmup configuration for the account

items[].added_bystring(uuid)read-only

User ID who added the account

Example: "01959271-1bb8-760e-a18e-24e152223702"

items[].daily_limitnumber

Daily email sending limit

Example: 100

items[].modified_bystring(uuid)read-only

User ID who last modified the account

Example: "01959271-1bb8-760e-a18e-24e2bfa1bf42"

items[].tracking_domain_namestring

Tracking domain

Example: "example.com"

items[].tracking_domain_statusstring

Tracking domain status

Example: "active"

items[].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

items[].enable_slow_rampboolean

Whether to enable slow ramp up for sending limits

Example: false

items[].inbox_placement_test_limitboolean

Whether inbox placement test limit is enabled

Example: false

items[].timestamp_last_usedstring(date-time)read-only

Timestamp when the account was last used

Example: "2025-03-14T02:17:21.080Z"

items[].status_messagestringread-only

Status message for the account

Example: "Account is working normally"

items[].timestamp_warmup_startedstring(date-time)read-only

Timestamp when warmup was started

Example: "2025-03-14T02:17:21.080Z"

items[].warmup_pool_idstring(uuid)read-only

ID of the warmup pool this account belongs to

Example: "01959271-1bb8-760e-a18e-24e4ec02ee8a"

items[].dfy_password_changedbooleanread-only

Whether DFY password has been changed

Example: false

items[].stat_warmup_scorenumberread-only

Warmup score for the account

Example: 85

items[].sending_gapnumber[ 0 .. 1440 ]

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

Example: 10

next_starting_afterstring

The filter for getting the next items after this one, this could either be a UUID, a MongoDB ID, a timestamp, on an email depending on the specific API

Example: "0000-0000-0000-0000"

Response

application/json

{
  "items": [
    { … }
  ],
  "next_starting_after": "0000-0000-0000-0000"
}

Get account

Request

Requires one of the following scopes: accounts:read, accounts:all, all:read, all:all

Path

emailstringrequired

curl -i -X GET \
  'https://api.instantly.ai/api/v2/accounts/{email}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The requested Account

Bodyapplication/json

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-03-14T02:17:21.080Z"

timestamp_updatedstring(date-time)read-onlyrequired

Timestamp when the account was last updated

Example: "2025-03-14T02:17:21.080Z"

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: "01959271-1bb8-760e-a18e-24e3bee4230f"

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_bystring(uuid)read-only

User ID who added the account

Example: "01959271-1bb8-760e-a18e-24e152223702"

daily_limitnumber

Daily email sending limit

Example: 100

modified_bystring(uuid)read-only

User ID who last modified the account

Example: "01959271-1bb8-760e-a18e-24e2bfa1bf42"

tracking_domain_namestring

Tracking domain

Example: "example.com"

tracking_domain_statusstring

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_rampboolean

Whether to enable slow ramp up for sending limits

Example: false

inbox_placement_test_limitboolean

Whether inbox placement test limit is enabled

Example: false

timestamp_last_usedstring(date-time)read-only

Timestamp when the account was last used

Example: "2025-03-14T02:17:21.080Z"

status_messagestringread-only

Status message for the account

Example: "Account is working normally"

timestamp_warmup_startedstring(date-time)read-only

Timestamp when warmup was started

Example: "2025-03-14T02:17:21.080Z"

warmup_pool_idstring(uuid)read-only

ID of the warmup pool this account belongs to

Example: "01959271-1bb8-760e-a18e-24e4ec02ee8a"

dfy_password_changedbooleanread-only

Whether DFY password has been changed

Example: false

stat_warmup_scorenumberread-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

Response

application/json

{
  "email": "user@example.com",
  "timestamp_created": "2025-03-14T02:17:21.080Z",
  "timestamp_updated": "2025-03-14T02:17:21.080Z",
  "first_name": "John",
  "last_name": "Doe",
  "warmup": {
    "limit": 100,
    "advanced": { … },
    "warmup_custom_ftag": "warmup",
    "increment": "disabled",
    "reply_rate": 0.1
  },
  "added_by": "01959271-1bb8-760e-a18e-24e152223702",
  "daily_limit": 100,
  "modified_by": "01959271-1bb8-760e-a18e-24e2bfa1bf42",
  "tracking_domain_name": "example.com",
  "tracking_domain_status": "active",
  "status": 1,
  "enable_slow_ramp": false,
  "inbox_placement_test_limit": false,
  "organization": "01959271-1bb8-760e-a18e-24e3bee4230f",
  "timestamp_last_used": "2025-03-14T02:17:21.080Z",
  "warmup_status": 1,
  "status_message": "Account is working normally",
  "timestamp_warmup_started": "2025-03-14T02:17:21.080Z",
  "provider_code": 2,
  "setup_pending": false,
  "warmup_pool_id": "01959271-1bb8-760e-a18e-24e4ec02ee8a",
  "is_managed_account": false,
  "dfy_password_changed": false,
  "stat_warmup_score": 85,
  "sending_gap": 10
}

Patch account

Request

Requires one of the following scopes: accounts:update, accounts:all, all:update, all:all

Path

emailstringrequired

Bodyapplication/json

non-empty

emailstring(email)

Email address of the account

Example: "user@example.com"

first_namestring

First name associated with the account

Example: "John"

last_namestring

Last name associated with the account

Example: "Doe"

warmupobject

Warmup configuration for the account

daily_limitnumber

Daily email sending limit

Example: 100

tracking_domain_namestring

Tracking domain

Example: "example.com"

tracking_domain_statusstring

Tracking domain status

Example: "active"

enable_slow_rampboolean

Whether to enable slow ramp up for sending limits

Example: false

inbox_placement_test_limitboolean

Whether inbox placement test limit is enabled

Example: false

sending_gapnumber[ 0 .. 1440 ]

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

Example: 10

skip_cname_checkboolean

Example: false

remove_tracking_domainboolean

Example: false

curl -i -X PATCH \
  'https://api.instantly.ai/api/v2/accounts/{email}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

The updated Account

Bodyapplication/json

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-03-14T02:17:21.080Z"

timestamp_updatedstring(date-time)read-onlyrequired

Timestamp when the account was last updated

Example: "2025-03-14T02:17:21.080Z"

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: "01959271-1bb8-760e-a18e-24e3bee4230f"

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_bystring(uuid)read-only

User ID who added the account

Example: "01959271-1bb8-760e-a18e-24e152223702"

daily_limitnumber

Daily email sending limit

Example: 100

modified_bystring(uuid)read-only

User ID who last modified the account

Example: "01959271-1bb8-760e-a18e-24e2bfa1bf42"

tracking_domain_namestring

Tracking domain

Example: "example.com"

tracking_domain_statusstring

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_rampboolean

Whether to enable slow ramp up for sending limits

Example: false

inbox_placement_test_limitboolean

Whether inbox placement test limit is enabled

Example: false

timestamp_last_usedstring(date-time)read-only

Timestamp when the account was last used

Example: "2025-03-14T02:17:21.080Z"

status_messagestringread-only

Status message for the account

Example: "Account is working normally"

timestamp_warmup_startedstring(date-time)read-only

Timestamp when warmup was started

Example: "2025-03-14T02:17:21.080Z"

warmup_pool_idstring(uuid)read-only

ID of the warmup pool this account belongs to

Example: "01959271-1bb8-760e-a18e-24e4ec02ee8a"

dfy_password_changedbooleanread-only

Whether DFY password has been changed

Example: false

stat_warmup_scorenumberread-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

Response

application/json

{
  "email": "user@example.com",
  "timestamp_created": "2025-03-14T02:17:21.080Z",
  "timestamp_updated": "2025-03-14T02:17:21.080Z",
  "first_name": "John",
  "last_name": "Doe",
  "warmup": {
    "limit": 100,
    "advanced": { … },
    "warmup_custom_ftag": "warmup",
    "increment": "disabled",
    "reply_rate": 0.1
  },
  "added_by": "01959271-1bb8-760e-a18e-24e152223702",
  "daily_limit": 100,
  "modified_by": "01959271-1bb8-760e-a18e-24e2bfa1bf42",
  "tracking_domain_name": "example.com",
  "tracking_domain_status": "active",
  "status": 1,
  "enable_slow_ramp": false,
  "inbox_placement_test_limit": false,
  "organization": "01959271-1bb8-760e-a18e-24e3bee4230f",
  "timestamp_last_used": "2025-03-14T02:17:21.080Z",
  "warmup_status": 1,
  "status_message": "Account is working normally",
  "timestamp_warmup_started": "2025-03-14T02:17:21.080Z",
  "provider_code": 2,
  "setup_pending": false,
  "warmup_pool_id": "01959271-1bb8-760e-a18e-24e4ec02ee8a",
  "is_managed_account": false,
  "dfy_password_changed": false,
  "stat_warmup_score": 85,
  "sending_gap": 10
}

Delete account

Request

Requires one of the following scopes: accounts:delete, accounts:all, all:delete, all:all

Path

emailstringrequired

curl -i -X DELETE \
  'https://api.instantly.ai/api/v2/accounts/{email}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The deleted Account

Bodyapplication/json

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-03-14T02:17:21.080Z"

timestamp_updatedstring(date-time)read-onlyrequired

Timestamp when the account was last updated

Example: "2025-03-14T02:17:21.080Z"

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: "01959271-1bb8-760e-a18e-24e3bee4230f"

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_bystring(uuid)read-only

User ID who added the account

Example: "01959271-1bb8-760e-a18e-24e152223702"

daily_limitnumber

Daily email sending limit

Example: 100

modified_bystring(uuid)read-only

User ID who last modified the account

Example: "01959271-1bb8-760e-a18e-24e2bfa1bf42"

tracking_domain_namestring

Tracking domain

Example: "example.com"

tracking_domain_statusstring

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_rampboolean

Whether to enable slow ramp up for sending limits

Example: false

inbox_placement_test_limitboolean

Whether inbox placement test limit is enabled

Example: false

timestamp_last_usedstring(date-time)read-only

Timestamp when the account was last used

Example: "2025-03-14T02:17:21.080Z"

status_messagestringread-only

Status message for the account

Example: "Account is working normally"

timestamp_warmup_startedstring(date-time)read-only

Timestamp when warmup was started

Example: "2025-03-14T02:17:21.080Z"

warmup_pool_idstring(uuid)read-only

ID of the warmup pool this account belongs to

Example: "01959271-1bb8-760e-a18e-24e4ec02ee8a"

dfy_password_changedbooleanread-only

Whether DFY password has been changed

Example: false

stat_warmup_scorenumberread-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

Response

application/json

{
  "email": "user@example.com",
  "timestamp_created": "2025-03-14T02:17:21.080Z",
  "timestamp_updated": "2025-03-14T02:17:21.080Z",
  "first_name": "John",
  "last_name": "Doe",
  "warmup": {
    "limit": 100,
    "advanced": { … },
    "warmup_custom_ftag": "warmup",
    "increment": "disabled",
    "reply_rate": 0.1
  },
  "added_by": "01959271-1bb8-760e-a18e-24e152223702",
  "daily_limit": 100,
  "modified_by": "01959271-1bb8-760e-a18e-24e2bfa1bf42",
  "tracking_domain_name": "example.com",
  "tracking_domain_status": "active",
  "status": 1,
  "enable_slow_ramp": false,
  "inbox_placement_test_limit": false,
  "organization": "01959271-1bb8-760e-a18e-24e3bee4230f",
  "timestamp_last_used": "2025-03-14T02:17:21.080Z",
  "warmup_status": 1,
  "status_message": "Account is working normally",
  "timestamp_warmup_started": "2025-03-14T02:17:21.080Z",
  "provider_code": 2,
  "setup_pending": false,
  "warmup_pool_id": "01959271-1bb8-760e-a18e-24e4ec02ee8a",
  "is_managed_account": false,
  "dfy_password_changed": false,
  "stat_warmup_score": 85,
  "sending_gap": 10
}

Get warmup analytics

Request

Requires one of the following scopes: accounts:read, accounts:all, all:read, all:all

Bodyapplication/jsonrequired

emailsArray of strings[ 1 .. 100 ] itemsrequired

List of emails to get warmup analytics for. The emails should be attached to accounts in your workspace.

Example: ["user@example.com"]

curl -i -X POST \
  https://api.instantly.ai/api/v2/accounts/warmup-analytics \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "emails": [
      "user@example.com"
    ]
  }'

Responses

Default Response

Bodyapplication/json

email_date_dataobject

Example: {"example1@example.com":{"2023-10-01":{"sent":10,"landed_inbox":8,"landed_spam":2,"received":10},"2023-10-02":{"sent":5,"landed_inbox":5,"received":5}},"example2@example.com":{"2023-10-01":{"sent":7,"landed_inbox":7,"received":7}}}

aggregate_dataobject

Example: {"example1@example.com":{"sent":15,"landed_inbox":13,"landed_spam":2,"received":15,"health_score_label":"87%","health_score":87},"example2@example.com":{"sent":7,"landed_inbox":7,"health_score_label":"100%","health_score":100}}

Response

application/json

{
  "email_date_data": {
    "example1@example.com": { … },
    "example2@example.com": { … }
  },
  "aggregate_data": {
    "example1@example.com": { … },
    "example2@example.com": { … }
  }
}

Pause an account

Request

Requires one of the following scopes: accounts:update, accounts:all, all:update, all:all

Path

emailstringrequired

Account email

Example: user@example.com

curl -i -X POST \
  https://api.instantly.ai/api/v2/accounts/user@example.com/pause \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The requested Account

Bodyapplication/json

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-03-14T02:17:21.080Z"

timestamp_updatedstring(date-time)read-onlyrequired

Timestamp when the account was last updated

Example: "2025-03-14T02:17:21.080Z"

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: "01959271-1bb8-760e-a18e-24e3bee4230f"

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_bystring(uuid)read-only

User ID who added the account

Example: "01959271-1bb8-760e-a18e-24e152223702"

daily_limitnumber

Daily email sending limit

Example: 100

modified_bystring(uuid)read-only

User ID who last modified the account

Example: "01959271-1bb8-760e-a18e-24e2bfa1bf42"

tracking_domain_namestring

Tracking domain

Example: "example.com"

tracking_domain_statusstring

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_rampboolean

Whether to enable slow ramp up for sending limits

Example: false

inbox_placement_test_limitboolean

Whether inbox placement test limit is enabled

Example: false

timestamp_last_usedstring(date-time)read-only

Timestamp when the account was last used

Example: "2025-03-14T02:17:21.080Z"

status_messagestringread-only

Status message for the account

Example: "Account is working normally"

timestamp_warmup_startedstring(date-time)read-only

Timestamp when warmup was started

Example: "2025-03-14T02:17:21.080Z"

warmup_pool_idstring(uuid)read-only

ID of the warmup pool this account belongs to

Example: "01959271-1bb8-760e-a18e-24e4ec02ee8a"

dfy_password_changedbooleanread-only

Whether DFY password has been changed

Example: false

stat_warmup_scorenumberread-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

Response

application/json

{
  "email": "user@example.com",
  "timestamp_created": "2025-03-14T02:17:21.080Z",
  "timestamp_updated": "2025-03-14T02:17:21.080Z",
  "first_name": "John",
  "last_name": "Doe",
  "warmup": {
    "limit": 100,
    "advanced": { … },
    "warmup_custom_ftag": "warmup",
    "increment": "disabled",
    "reply_rate": 0.1
  },
  "added_by": "01959271-1bb8-760e-a18e-24e152223702",
  "daily_limit": 100,
  "modified_by": "01959271-1bb8-760e-a18e-24e2bfa1bf42",
  "tracking_domain_name": "example.com",
  "tracking_domain_status": "active",
  "status": 1,
  "enable_slow_ramp": false,
  "inbox_placement_test_limit": false,
  "organization": "01959271-1bb8-760e-a18e-24e3bee4230f",
  "timestamp_last_used": "2025-03-14T02:17:21.080Z",
  "warmup_status": 1,
  "status_message": "Account is working normally",
  "timestamp_warmup_started": "2025-03-14T02:17:21.080Z",
  "provider_code": 2,
  "setup_pending": false,
  "warmup_pool_id": "01959271-1bb8-760e-a18e-24e4ec02ee8a",
  "is_managed_account": false,
  "dfy_password_changed": false,
  "stat_warmup_score": 85,
  "sending_gap": 10
}

Resume a paused account

Request

Requires one of the following scopes: accounts:update, accounts:all, all:update, all:all

Path

emailstringrequired

Account email

Example: user@example.com

curl -i -X POST \
  https://api.instantly.ai/api/v2/accounts/user@example.com/resume \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The requested Account

Bodyapplication/json

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-03-14T02:17:21.080Z"

timestamp_updatedstring(date-time)read-onlyrequired

Timestamp when the account was last updated

Example: "2025-03-14T02:17:21.080Z"

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: "01959271-1bb8-760e-a18e-24e3bee4230f"

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_bystring(uuid)read-only

User ID who added the account

Example: "01959271-1bb8-760e-a18e-24e152223702"

daily_limitnumber

Daily email sending limit

Example: 100

modified_bystring(uuid)read-only

User ID who last modified the account

Example: "01959271-1bb8-760e-a18e-24e2bfa1bf42"

tracking_domain_namestring

Tracking domain

Example: "example.com"

tracking_domain_statusstring

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_rampboolean

Whether to enable slow ramp up for sending limits

Example: false

inbox_placement_test_limitboolean

Whether inbox placement test limit is enabled

Example: false

timestamp_last_usedstring(date-time)read-only

Timestamp when the account was last used

Example: "2025-03-14T02:17:21.080Z"

status_messagestringread-only

Status message for the account

Example: "Account is working normally"

timestamp_warmup_startedstring(date-time)read-only

Timestamp when warmup was started

Example: "2025-03-14T02:17:21.080Z"

warmup_pool_idstring(uuid)read-only

ID of the warmup pool this account belongs to

Example: "01959271-1bb8-760e-a18e-24e4ec02ee8a"

dfy_password_changedbooleanread-only

Whether DFY password has been changed

Example: false

stat_warmup_scorenumberread-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

Response

application/json

{
  "email": "user@example.com",
  "timestamp_created": "2025-03-14T02:17:21.080Z",
  "timestamp_updated": "2025-03-14T02:17:21.080Z",
  "first_name": "John",
  "last_name": "Doe",
  "warmup": {
    "limit": 100,
    "advanced": { … },
    "warmup_custom_ftag": "warmup",
    "increment": "disabled",
    "reply_rate": 0.1
  },
  "added_by": "01959271-1bb8-760e-a18e-24e152223702",
  "daily_limit": 100,
  "modified_by": "01959271-1bb8-760e-a18e-24e2bfa1bf42",
  "tracking_domain_name": "example.com",
  "tracking_domain_status": "active",
  "status": 1,
  "enable_slow_ramp": false,
  "inbox_placement_test_limit": false,
  "organization": "01959271-1bb8-760e-a18e-24e3bee4230f",
  "timestamp_last_used": "2025-03-14T02:17:21.080Z",
  "warmup_status": 1,
  "status_message": "Account is working normally",
  "timestamp_warmup_started": "2025-03-14T02:17:21.080Z",
  "provider_code": 2,
  "setup_pending": false,
  "warmup_pool_id": "01959271-1bb8-760e-a18e-24e4ec02ee8a",
  "is_managed_account": false,
  "dfy_password_changed": false,
  "stat_warmup_score": 85,
  "sending_gap": 10
}

Mark an account as fixed

Request

Requires one of the following scopes: accounts:update, accounts:all, all:update, all:all

Path

emailstringrequired

Account email

Example: user@example.com

curl -i -X POST \
  https://api.instantly.ai/api/v2/accounts/user@example.com/mark-fixed \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The requested Account

Bodyapplication/json

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-03-14T02:17:21.080Z"

timestamp_updatedstring(date-time)read-onlyrequired

Timestamp when the account was last updated

Example: "2025-03-14T02:17:21.080Z"

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: "01959271-1bb8-760e-a18e-24e3bee4230f"

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_bystring(uuid)read-only

User ID who added the account

Example: "01959271-1bb8-760e-a18e-24e152223702"

daily_limitnumber

Daily email sending limit

Example: 100

modified_bystring(uuid)read-only

User ID who last modified the account

Example: "01959271-1bb8-760e-a18e-24e2bfa1bf42"

tracking_domain_namestring

Tracking domain

Example: "example.com"

tracking_domain_statusstring

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_rampboolean

Whether to enable slow ramp up for sending limits

Example: false

inbox_placement_test_limitboolean

Whether inbox placement test limit is enabled

Example: false

timestamp_last_usedstring(date-time)read-only

Timestamp when the account was last used

Example: "2025-03-14T02:17:21.080Z"

status_messagestringread-only

Status message for the account

Example: "Account is working normally"

timestamp_warmup_startedstring(date-time)read-only

Timestamp when warmup was started

Example: "2025-03-14T02:17:21.080Z"

warmup_pool_idstring(uuid)read-only

ID of the warmup pool this account belongs to

Example: "01959271-1bb8-760e-a18e-24e4ec02ee8a"

dfy_password_changedbooleanread-only

Whether DFY password has been changed

Example: false

stat_warmup_scorenumberread-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

Response

application/json

{
  "email": "user@example.com",
  "timestamp_created": "2025-03-14T02:17:21.080Z",
  "timestamp_updated": "2025-03-14T02:17:21.080Z",
  "first_name": "John",
  "last_name": "Doe",
  "warmup": {
    "limit": 100,
    "advanced": { … },
    "warmup_custom_ftag": "warmup",
    "increment": "disabled",
    "reply_rate": 0.1
  },
  "added_by": "01959271-1bb8-760e-a18e-24e152223702",
  "daily_limit": 100,
  "modified_by": "01959271-1bb8-760e-a18e-24e2bfa1bf42",
  "tracking_domain_name": "example.com",
  "tracking_domain_status": "active",
  "status": 1,
  "enable_slow_ramp": false,
  "inbox_placement_test_limit": false,
  "organization": "01959271-1bb8-760e-a18e-24e3bee4230f",
  "timestamp_last_used": "2025-03-14T02:17:21.080Z",
  "warmup_status": 1,
  "status_message": "Account is working normally",
  "timestamp_warmup_started": "2025-03-14T02:17:21.080Z",
  "provider_code": 2,
  "setup_pending": false,
  "warmup_pool_id": "01959271-1bb8-760e-a18e-24e4ec02ee8a",
  "is_managed_account": false,
  "dfy_password_changed": false,
  "stat_warmup_score": 85,
  "sending_gap": 10
}

Get custom tracking domain status

Request

Requires one of the following scopes: accounts:read, accounts:all, all:read, all:all

Query

hoststringrequired

Custom tracking domain host

Example: host=example.com

curl -i -X GET \
  'https://api.instantly.ai/api/v2/accounts/ctd/status?host=example.com' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Default Response

Bodyapplication/json

successboolean

Example: true

sslboolean

Example: true

cnameboolean

Example: true

hoststring

Example: "example.com"

Response

application/json

{
  "success": true,
  "ssl": true,
  "cname": true,
  "host": "example.com"
}

Test account vitals

Request

Requires one of the following scopes: accounts:read, accounts:all, all:read, all:all

Bodyapplication/json

accountsArray of strings

Example: ["user@example.com"]

curl -i -X POST \
  https://api.instantly.ai/api/v2/accounts/test/vitals \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Default Response

Bodyapplication/json

statusstring

Example: "success"

success_listArray of objects

failure_listArray of objects

Response

application/json

{
  "status": "success",
  "success_list": [
    { … }
  ],
  "failure_list": [
    { … }
  ]
}

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 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

API Explorer (2.0.0)

Analytics

Account

Account

Create account

RequestExpand all

Responses

Was this helpful?

List account

Request

Responses

Was this helpful?

Get account

Request

Responses

Was this helpful?

Patch account

RequestExpand all

Responses

Was this helpful?

Delete account

Request

Responses

Was this helpful?

Get warmup analytics

Request

Responses

Was this helpful?

Pause an account

Request

Responses

Was this helpful?

Resume a paused account

Request

Responses

Was this helpful?

Mark an account as fixed

Request

Responses

Was this helpful?

Get custom tracking domain status

Request

Responses

Was this helpful?

Test account vitals

Request

Responses

Was this helpful?

Campaign

Email

Email Verification

Lead List

Inbox Placement Test

Inbox Placement Analytics

Inbox Placement Blacklist & SpamAssassin Report

API Key

Account Campaign Mapping

Lead

Background Job

Custom Tag

Block List Entry

Lead Label

Workspace

Workspace Group Member

Workspace Member

Campaign Subsequence

Schemas

Request

Request