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

Block List Entry

A blocked email or domain

idstring(uuid)read-onlyrequired

Unique identifier for the block list entry

Example: "019ad090-2964-7a35-ac51-c05bcfd051c2"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the block list entry was created

Example: "2025-11-29T17:01:40.068Z"

organization_idstring(uuid)read-onlyrequired

Organization ID that owns this block list entry

Example: "019ad090-2964-7a35-ac51-c05ce70edf8f"

bl_valuestringrequired

The email or domain to block

Example: "example.com"

is_domainbooleanread-onlyrequired

Whether this entry blocks an entire domain

Example: true

{
  "id": "019ad090-2964-7a35-ac51-c05bcfd051c2",
  "timestamp_created": "2025-11-29T17:01:40.068Z",
  "organization_id": "019ad090-2964-7a35-ac51-c05ce70edf8f",
  "bl_value": "example.com",
  "is_domain": true
}

Create block list entry

Request

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

Bodyapplication/jsonrequired

The Block List Entry to create

bl_valuestringrequired

The email or domain to block

Example: "example.com"

curl -i -X POST \
  https://api.instantly.ai/api/v2/block-lists-entries \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "bl_value": "example.com"
  }'

Responses

The Block List Entry

Bodyapplication/json

idstring(uuid)read-onlyrequired

Unique identifier for the block list entry

Example: "019ad090-2964-7a35-ac51-c05bcfd051c2"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the block list entry was created

Example: "2025-11-29T17:01:40.068Z"

organization_idstring(uuid)read-onlyrequired

Organization ID that owns this block list entry

Example: "019ad090-2964-7a35-ac51-c05ce70edf8f"

bl_valuestringrequired

The email or domain to block

Example: "example.com"

is_domainbooleanread-onlyrequired

Whether this entry blocks an entire domain

Example: true

Response

application/json

{
  "id": "019ad090-2964-7a35-ac51-c05bcfd051c2",
  "timestamp_created": "2025-11-29T17:01:40.068Z",
  "organization_id": "019ad090-2964-7a35-ac51-c05ce70edf8f",
  "bl_value": "example.com",
  "is_domain": true
}

List block list entry

Request

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

Query

limitinteger[ 1 .. 100 ]

The number of items to return

Example: limit=10

starting_afterstring

The ID of the last item in the previous page - used for pagination. You can use the value of the next_starting_after field from the previous response.

Example: starting_after=01956fbd-0eb1-72db-a565-82977a586084

domains_onlyboolean

Filter by domain

Example: domains_only=true

searchstring

Search by value

Example: search=example.com

curl -i -X GET \
  'https://api.instantly.ai/api/v2/block-lists-entries?domains_only=true&limit=10&search=example.com&starting_after=01956fbd-0eb1-72db-a565-82977a586084' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The list of Block List Entry

Bodyapplication/json

itemsArray of objects(Block List Entry)required

The list of Block List Entry

items[].idstring(uuid)read-onlyrequired

Unique identifier for the block list entry

Example: "019ad090-2964-7a35-ac51-c05bcfd051c2"

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

Timestamp when the block list entry was created

Example: "2025-11-29T17:01:40.068Z"

items[].organization_idstring(uuid)read-onlyrequired

Organization ID that owns this block list entry

Example: "019ad090-2964-7a35-ac51-c05ce70edf8f"

items[].bl_valuestringrequired

The email or domain to block

Example: "example.com"

items[].is_domainbooleanread-onlyrequired

Whether this entry blocks an entire domain

Example: true

next_starting_afterstring

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

Example: "019ad090-3988-749e-be85-f8e1e396f731"

Response

application/json

{
  "items": [
    { … }
  ],
  "next_starting_after": "019ad090-3988-749e-be85-f8e1e396f731"
}

Get block list entry

Request

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

Path

idstring(uuid)required

The ID of the requested item

Example: 019ad090-3988-749e-be85-f8e0a9ab9872

curl -i -X GET \
  https://api.instantly.ai/api/v2/block-lists-entries/019ad090-3988-749e-be85-f8e0a9ab9872 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The requested Block List Entry

Bodyapplication/json

idstring(uuid)read-onlyrequired

Unique identifier for the block list entry

Example: "019ad090-2964-7a35-ac51-c05bcfd051c2"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the block list entry was created

Example: "2025-11-29T17:01:40.068Z"

organization_idstring(uuid)read-onlyrequired

Organization ID that owns this block list entry

Example: "019ad090-2964-7a35-ac51-c05ce70edf8f"

bl_valuestringrequired

The email or domain to block

Example: "example.com"

is_domainbooleanread-onlyrequired

Whether this entry blocks an entire domain

Example: true

Response

application/json

{
  "id": "019ad090-2964-7a35-ac51-c05bcfd051c2",
  "timestamp_created": "2025-11-29T17:01:40.068Z",
  "organization_id": "019ad090-2964-7a35-ac51-c05ce70edf8f",
  "bl_value": "example.com",
  "is_domain": true
}

Patch block list entry

Request

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

Path

idstring(uuid)required

The ID of the item to update

Example: 019ad090-3989-7df7-bee5-326f176215a9

Bodyapplication/json

non-empty

bl_valuestring

The email or domain to block

Example: "example.com"

curl -i -X PATCH \
  https://api.instantly.ai/api/v2/block-lists-entries/019ad090-3989-7df7-bee5-326f176215a9 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

The updated Block List Entry

Bodyapplication/json

idstring(uuid)read-onlyrequired

Unique identifier for the block list entry

Example: "019ad090-2964-7a35-ac51-c05bcfd051c2"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the block list entry was created

Example: "2025-11-29T17:01:40.068Z"

organization_idstring(uuid)read-onlyrequired

Organization ID that owns this block list entry

Example: "019ad090-2964-7a35-ac51-c05ce70edf8f"

bl_valuestringrequired

The email or domain to block

Example: "example.com"

is_domainbooleanread-onlyrequired

Whether this entry blocks an entire domain

Example: true

Response

application/json

{
  "id": "019ad090-2964-7a35-ac51-c05bcfd051c2",
  "timestamp_created": "2025-11-29T17:01:40.068Z",
  "organization_id": "019ad090-2964-7a35-ac51-c05ce70edf8f",
  "bl_value": "example.com",
  "is_domain": true
}

Delete block list entry

Request

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

Path

idstring(uuid)required

The ID of the item to delete

Example: 019ad090-398c-7ea3-ba8a-0b7311eab16f

Bodyapplication/json

null

curl -i -X DELETE \
  https://api.instantly.ai/api/v2/block-lists-entries/019ad090-398c-7ea3-ba8a-0b7311eab16f \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json'

Responses

The deleted Block List Entry

Bodyapplication/json

idstring(uuid)read-onlyrequired

Unique identifier for the block list entry

Example: "019ad090-2964-7a35-ac51-c05bcfd051c2"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the block list entry was created

Example: "2025-11-29T17:01:40.068Z"

organization_idstring(uuid)read-onlyrequired

Organization ID that owns this block list entry

Example: "019ad090-2964-7a35-ac51-c05ce70edf8f"

bl_valuestringrequired

The email or domain to block

Example: "example.com"

is_domainbooleanread-onlyrequired

Whether this entry blocks an entire domain

Example: true

Response

application/json

{
  "id": "019ad090-2964-7a35-ac51-c05bcfd051c2",
  "timestamp_created": "2025-11-29T17:01:40.068Z",
  "organization_id": "019ad090-2964-7a35-ac51-c05ce70edf8f",
  "bl_value": "example.com",
  "is_domain": true
}

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

Operations

CRM Actions

CRM related actions

Operations

API Explorer (2.0.0)

Analytics

Account

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

Block List Entry

Create block list entry

Request

Responses

Was this helpful?

List block list entry

Request

Responses

Was this helpful?

Get block list entry

Request

Responses

Was this helpful?

Patch block list entry

Request

Responses

Was this helpful?

Delete block list entry

Request

Responses

Was this helpful?

Lead Label

Workspace

SuperSearch Enrichment

Workspace Group Member

Workspace Member

Campaign Subsequence

Audit Log

Webhook

Webhook Event

DFY Email Account Order

Custom Prompt Template

Sales Flow

Email Template

Workspace Billing

CRM Actions

Schemas