Account
/
Patch account

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

Get account

Request

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

Path
emailstringrequired

The email of the account to get

Example: jon@doe.com
curl -i -X GET \
  https://api.instantly.ai/api/v2/accounts/jon@doe.com \
  -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-12-22T22:48:00.179Z"
timestamp_updatedstring(date-time)read-onlyrequired

Timestamp when the account was last updated

Example: "2025-12-22T22:48:00.179Z"
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: "019b483f-81b3-7bef-9fcc-1655446f3d39"
warmup_statusnumberread-onlyrequired

Current warmup status of the account

Enum ValueDescription
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 ValueDescription
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: "019b483f-81b3-7bef-9fcc-16531eb5fdd8"
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: "019b483f-81b3-7bef-9fcc-1654dca0eb9e"
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 ValueDescription
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-12-22T22:48:00.179Z"
status_messageobjectread-only

Status message for the account

timestamp_warmup_startnull or string(date-time)read-only

Timestamp when warmup was started

Example: "2025-12-22T22:48:00.179Z"
warmup_pool_idnull or string(uuid)read-only

ID of the warmup pool this account belongs to

Example: "019b483f-81b3-7bef-9fcc-1656572bf9d4"
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
Response
application/json
{
  "email": "user@example.com",
  "timestamp_created": "2025-12-22T22:48:00.179Z",
  "timestamp_updated": "2025-12-22T22:48:00.179Z",
  "first_name": "John",
  "last_name": "Doe",
  "warmup": {
    "limit": 100,
    "advanced": { … },
    "warmup_custom_ftag": "warmup",
    "increment": "disabled",
    "reply_rate": 0.1
  },
  "added_by": "019b483f-81b3-7bef-9fcc-16531eb5fdd8",
  "daily_limit": 100,
  "modified_by": "019b483f-81b3-7bef-9fcc-1654dca0eb9e",
  "tracking_domain_name": "example.com",
  "tracking_domain_status": "active",
  "status": 1,
  "enable_slow_ramp": false,
  "inbox_placement_test_limit": 10,
  "organization": "019b483f-81b3-7bef-9fcc-1655446f3d39",
  "timestamp_last_used": "2025-12-22T22:48:00.179Z",
  "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-12-22T22:48:00.179Z",
  "provider_code": 2,
  "setup_pending": false,
  "warmup_pool_id": "019b483f-81b3-7bef-9fcc-1656572bf9d4",
  "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

The email of the account to update

Example: jon@doe.com
Bodyapplication/json
non-empty
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 or null

Daily email sending limit

Example: 100
tracking_domain_namestring or null

Tracking domain

Example: "example.com"
tracking_domain_statusstring or null

Tracking domain status

Example: "active"
enable_slow_rampboolean or null

Whether to enable slow ramp up for sending limits

Example: false
inbox_placement_test_limitnumber or null

The limit for inbox placement tests

Example: 10
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/jon@doe.com \
  -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-12-22T22:48:00.179Z"
timestamp_updatedstring(date-time)read-onlyrequired

Timestamp when the account was last updated

Example: "2025-12-22T22:48:00.179Z"
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: "019b483f-81b3-7bef-9fcc-1655446f3d39"
warmup_statusnumberread-onlyrequired

Current warmup status of the account

Enum ValueDescription
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 ValueDescription
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: "019b483f-81b3-7bef-9fcc-16531eb5fdd8"
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: "019b483f-81b3-7bef-9fcc-1654dca0eb9e"
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 ValueDescription
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-12-22T22:48:00.179Z"
status_messageobjectread-only

Status message for the account

timestamp_warmup_startnull or string(date-time)read-only

Timestamp when warmup was started

Example: "2025-12-22T22:48:00.179Z"
warmup_pool_idnull or string(uuid)read-only

ID of the warmup pool this account belongs to

Example: "019b483f-81b3-7bef-9fcc-1656572bf9d4"
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
Response
application/json
{
  "email": "user@example.com",
  "timestamp_created": "2025-12-22T22:48:00.179Z",
  "timestamp_updated": "2025-12-22T22:48:00.179Z",
  "first_name": "John",
  "last_name": "Doe",
  "warmup": {
    "limit": 100,
    "advanced": { … },
    "warmup_custom_ftag": "warmup",
    "increment": "disabled",
    "reply_rate": 0.1
  },
  "added_by": "019b483f-81b3-7bef-9fcc-16531eb5fdd8",
  "daily_limit": 100,
  "modified_by": "019b483f-81b3-7bef-9fcc-1654dca0eb9e",
  "tracking_domain_name": "example.com",
  "tracking_domain_status": "active",
  "status": 1,
  "enable_slow_ramp": false,
  "inbox_placement_test_limit": 10,
  "organization": "019b483f-81b3-7bef-9fcc-1655446f3d39",
  "timestamp_last_used": "2025-12-22T22:48:00.179Z",
  "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-12-22T22:48:00.179Z",
  "provider_code": 2,
  "setup_pending": false,
  "warmup_pool_id": "019b483f-81b3-7bef-9fcc-1656572bf9d4",
  "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

The email of the account to get

Example: jon@doe.com
Bodyapplication/json
null
curl -i -X DELETE \
  https://api.instantly.ai/api/v2/accounts/jon@doe.com \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json'

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-12-22T22:48:00.179Z"
timestamp_updatedstring(date-time)read-onlyrequired

Timestamp when the account was last updated

Example: "2025-12-22T22:48:00.179Z"
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: "019b483f-81b3-7bef-9fcc-1655446f3d39"
warmup_statusnumberread-onlyrequired

Current warmup status of the account

Enum ValueDescription
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 ValueDescription
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: "019b483f-81b3-7bef-9fcc-16531eb5fdd8"
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: "019b483f-81b3-7bef-9fcc-1654dca0eb9e"
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 ValueDescription
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-12-22T22:48:00.179Z"
status_messageobjectread-only

Status message for the account

timestamp_warmup_startnull or string(date-time)read-only

Timestamp when warmup was started

Example: "2025-12-22T22:48:00.179Z"
warmup_pool_idnull or string(uuid)read-only

ID of the warmup pool this account belongs to

Example: "019b483f-81b3-7bef-9fcc-1656572bf9d4"
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
Response
application/json
{
  "email": "user@example.com",
  "timestamp_created": "2025-12-22T22:48:00.179Z",
  "timestamp_updated": "2025-12-22T22:48:00.179Z",
  "first_name": "John",
  "last_name": "Doe",
  "warmup": {
    "limit": 100,
    "advanced": { … },
    "warmup_custom_ftag": "warmup",
    "increment": "disabled",
    "reply_rate": 0.1
  },
  "added_by": "019b483f-81b3-7bef-9fcc-16531eb5fdd8",
  "daily_limit": 100,
  "modified_by": "019b483f-81b3-7bef-9fcc-1654dca0eb9e",
  "tracking_domain_name": "example.com",
  "tracking_domain_status": "active",
  "status": 1,
  "enable_slow_ramp": false,
  "inbox_placement_test_limit": 10,
  "organization": "019b483f-81b3-7bef-9fcc-1655446f3d39",
  "timestamp_last_used": "2025-12-22T22:48:00.179Z",
  "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-12-22T22:48:00.179Z",
  "provider_code": 2,
  "setup_pending": false,
  "warmup_pool_id": "019b483f-81b3-7bef-9fcc-1656572bf9d4",
  "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

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

Custom Tag Mapping

This entity represents a tag being assigned to a specific campaign or email account. When an email account is assigned a tag, a new custom tag mapping entry is created, which connects the tag (tag_id field) with the email account (resource_id field). You can use it to see which tag si connected to which resource.

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

Custom Prompt Template

Custom prompt templates for creating custom prompts

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

CRM Actions

CRM related actions

Operations

Schemas