API Key

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

Inbox Placement Blacklist & SpamAssassin Report

Report data for an inbox placement test

idstring(uuid)read-onlyrequired

Unique identifier for the inbox placement report entry

Example: "01959271-1f6e-7be5-bc68-fdea7daed34c"

timestamp_createdstringread-onlyrequired

Timestamp when the inbox placement report was created

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

timestamp_created_datestringread-onlyrequired

Date when the inbox placement report was created

Example: "2025-03-14"

organization_idstring(uuid)read-onlyrequired

Organization ID

Example: "01959271-1f6e-7be5-bc68-fdeb50718ff2"

test_idstring(uuid)read-onlyrequired

Inbox Placement Test ID

Example: "01959271-1f6e-7be5-bc68-fdeced7f9434"

domainstringread-onlyrequired

Domain of the inbox placement report

Example: "growinstantly.com"

domain_ipstringread-onlyrequired

IP address of the domain

Example: "192.168.1.1"

spam_assassin_scorenumberread-onlyrequired

SpamAssassin score for the email, indicating spam likelihood

Example: 2.5

domain_blacklist_countnumberread-only

Count of blacklists the domain is listed on

Example: 5

domain_ip_blacklist_countnumberread-only

Count of blacklists the domain IP is listed on

Example: 3

spam_assassin_reportobjectread-only

Detailed SpamAssassin analysis report

blacklist_reportobjectread-only

Detailed blacklist report for the domain or IP

{
  "id": "01959271-1f6e-7be5-bc68-fdea7daed34c",
  "timestamp_created": "2025-03-14T02:17:22.030Z",
  "timestamp_created_date": "2025-03-14",
  "organization_id": "01959271-1f6e-7be5-bc68-fdeb50718ff2",
  "test_id": "01959271-1f6e-7be5-bc68-fdeced7f9434",
  "domain_blacklist_count": 5,
  "domain": "growinstantly.com",
  "domain_ip": "192.168.1.1",
  "domain_ip_blacklist_count": 3,
  "spam_assassin_score": 2.5,
  "spam_assassin_report": {
    "is_spam": false,
    "report": [ … ],
    "spam_score": 0
  },
  "blacklist_report": {
    "address": "growinstantly.com",
    "blacklisted_count": 5,
    "details": [],
    "ip": "104.21.62.47",
    "is_blacklisted": true,
    "is_domain": true
  }
}

API Key

idstring(uuid)read-onlyrequired

Example: "01959271-1f65-763e-8436-629113dbb79f"

namestringrequired

Example: "My API Key"

scopesArray of stringsrequired

Items Enum"all:all""all:create""all:read""all:update""all:delete""api_keys:all""api_keys:create""api_keys:read""api_keys:update""api_keys:delete"

Example: ["campaigns:create"]

keystringread-onlyrequired

Example: "a1b2c3d4e5f6g7h8i9j0"

organization_idstring(uuid)read-onlyrequired

Example: "01959271-1f66-78ab-87f9-ef3674de6102"

timestamp_createdstring(date-time)read-onlyrequired

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

timestamp_updatedstring(date-time)read-onlyrequired

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

{
  "id": "01959271-1f65-763e-8436-629113dbb79f",
  "name": "My API Key",
  "scopes": [
    "campaigns:create"
  ],
  "key": "a1b2c3d4e5f6g7h8i9j0",
  "organization_id": "01959271-1f66-78ab-87f9-ef3674de6102",
  "timestamp_created": "2025-03-14T02:17:22.022Z",
  "timestamp_updated": "2025-03-14T02:17:22.022Z"
}

Account Campaign Mapping

campaign_idstring(uuid)required

Example: "01959271-1f64-7d23-a573-18a9d6906d6b"

campaign_namestringrequired

Example: "Campaign Name"

timestamp_createdstringread-onlyrequired

Timestamp when the campaign was created

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

statusnumber

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_id": "01959271-1f64-7d23-a573-18a9d6906d6b",
  "campaign_name": "Campaign Name",
  "timestamp_created": "2025-03-14T02:17:22.020Z",
  "status": 1
}