Block List Entry

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

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

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: "0198e874-1316-7a38-b3a4-bdac0a2fcbdc"
timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the block list entry was created

Example: "2025-08-26T22:16:17.942Z"
organization_idstring(uuid)read-onlyrequired

Organization ID that owns this block list entry

Example: "0198e874-1316-7a38-b3a4-bdad8481ada2"
bl_valuestringrequired

The email or domain to block

Example: "example.com"
is_domainbooleanread-onlyrequired

Whether this entry blocks an entire domain

Example: true
{
  "id": "0198e874-1316-7a38-b3a4-bdac0a2fcbdc",
  "timestamp_created": "2025-08-26T22:16:17.942Z",
  "organization_id": "0198e874-1316-7a38-b3a4-bdad8481ada2",
  "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: "0198e874-1316-7a38-b3a4-bdac0a2fcbdc"
timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the block list entry was created

Example: "2025-08-26T22:16:17.942Z"
organization_idstring(uuid)read-onlyrequired

Organization ID that owns this block list entry

Example: "0198e874-1316-7a38-b3a4-bdad8481ada2"
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": "0198e874-1316-7a38-b3a4-bdac0a2fcbdc",
  "timestamp_created": "2025-08-26T22:16:17.942Z",
  "organization_id": "0198e874-1316-7a38-b3a4-bdad8481ada2",
  "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
items[].​idstring(uuid)read-onlyrequired

Unique identifier for the block list entry

Example: "0198e874-1316-7a38-b3a4-bdac0a2fcbdc"
items[].​timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the block list entry was created

Example: "2025-08-26T22:16:17.942Z"
items[].​organization_idstring(uuid)read-onlyrequired

Organization ID that owns this block list entry

Example: "0198e874-1316-7a38-b3a4-bdad8481ada2"
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 MongoDB ID, a timestamp, on an email depending on the specific API

Example: "0198e874-2591-7e4f-b4ea-52b037b62f30"
Response
application/json
{
  "items": [
    { … }
  ],
  "next_starting_after": "0198e874-2591-7e4f-b4ea-52b037b62f30"
}

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: 0198e874-2590-724f-9943-00d01be15d24
curl -i -X GET \
  https://api.instantly.ai/api/v2/block-lists-entries/0198e874-2590-724f-9943-00d01be15d24 \
  -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: "0198e874-1316-7a38-b3a4-bdac0a2fcbdc"
timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the block list entry was created

Example: "2025-08-26T22:16:17.942Z"
organization_idstring(uuid)read-onlyrequired

Organization ID that owns this block list entry

Example: "0198e874-1316-7a38-b3a4-bdad8481ada2"
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": "0198e874-1316-7a38-b3a4-bdac0a2fcbdc",
  "timestamp_created": "2025-08-26T22:16:17.942Z",
  "organization_id": "0198e874-1316-7a38-b3a4-bdad8481ada2",
  "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: 0198e874-2593-7793-9137-4490cb22db92
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/0198e874-2593-7793-9137-4490cb22db92 \
  -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: "0198e874-1316-7a38-b3a4-bdac0a2fcbdc"
timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the block list entry was created

Example: "2025-08-26T22:16:17.942Z"
organization_idstring(uuid)read-onlyrequired

Organization ID that owns this block list entry

Example: "0198e874-1316-7a38-b3a4-bdad8481ada2"
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": "0198e874-1316-7a38-b3a4-bdac0a2fcbdc",
  "timestamp_created": "2025-08-26T22:16:17.942Z",
  "organization_id": "0198e874-1316-7a38-b3a4-bdad8481ada2",
  "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: 0198e874-2593-7793-9137-449116c9d582
Bodyapplication/json
null
curl -i -X DELETE \
  https://api.instantly.ai/api/v2/block-lists-entries/0198e874-2593-7793-9137-449116c9d582 \
  -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: "0198e874-1316-7a38-b3a4-bdac0a2fcbdc"
timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the block list entry was created

Example: "2025-08-26T22:16:17.942Z"
organization_idstring(uuid)read-onlyrequired

Organization ID that owns this block list entry

Example: "0198e874-1316-7a38-b3a4-bdad8481ada2"
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": "0198e874-1316-7a38-b3a4-bdac0a2fcbdc",
  "timestamp_created": "2025-08-26T22:16:17.942Z",
  "organization_id": "0198e874-1316-7a38-b3a4-bdad8481ada2",
  "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

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