Custom Tag

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

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

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

Schemas

Background Job

A background job that can be used to perform long-running tasks

idstringread-onlyrequired

Unique identifier for the background job

Example: "675266e304a8e55b17f0228b"

workspace_idstring(uuid)read-onlyrequired

Workspace ID

Example: "019a5522-76d1-75ef-bd68-1fa6a0708410"

typestringrequired

Type of background job

Enum Value	Description
move-leads	Move Leads
import-leads	Import Leads
export-leads	Export Leads
update-warmup-accounts	Update Warmup Accounts
rename-variable	Rename Variable

Example: "move-leads"

progressnumber[ 0 .. 100 ]required

Progress of the job as a percentage (from 0 to 100)

Example: 0

statusstringrequired

Job status

Enum Value	Description
pending	The background job is waiting in the queue to be processed
in-progress	The background job is being processed
success	The background job has been successfully processed
failed	The background job has failed

Example: "pending"

created_atstringrequired

Timestamp when the job was created

Example: "2025-11-05T17:48:33.361Z"

updated_atstringrequired

Timestamp when the job was last updated

Example: "2025-11-05T17:48:33.361Z"

user_idnull or string(uuid)read-only

The id of the user that triggered the action that created the job

Example: "019a5522-76d1-75ef-bd68-1fa77368e661"

entity_idnull or string(uuid)

The id of the entity that the job is related to

Example: "019a5522-76d1-75ef-bd68-1fa8261bc458"

entity_typestring

Type of entity

Enum Value	Description
list	The entity is a lead list
campaign	The entity is a campaign
workspace	The entity is a workspace

Example: "list"

dataobject

Data about the job, used to store any additional information we need to process the job

{
  "id": "675266e304a8e55b17f0228b",
  "workspace_id": "019a5522-76d1-75ef-bd68-1fa6a0708410",
  "user_id": "019a5522-76d1-75ef-bd68-1fa77368e661",
  "type": "move-leads",
  "entity_id": "019a5522-76d1-75ef-bd68-1fa8261bc458",
  "entity_type": "list",
  "data": {},
  "progress": 0,
  "status": "pending",
  "created_at": "2025-11-05T17:48:33.361Z",
  "updated_at": "2025-11-05T17:48:33.361Z"
}

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.

idstring(uuid)read-onlyrequired

Unique identifier for the custom tag

Example: "019a5522-76d2-7de4-b93b-aeb9306e2fef"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the custom tag was created

Example: "2025-11-05T17:48:33.362Z"

timestamp_updatedstring(date-time)read-onlyrequired

Timestamp when the custom tag was last updated

Example: "2025-11-05T17:48:33.362Z"

organization_idstring(uuid)read-onlyrequired

Organization ID that owns this custom tag

Example: "019a5522-76d2-7de4-b93b-aeba2a101d4a"

labelstringrequired

Display label for the custom tag

Example: "Important"

descriptionnull or string

Detailed description of the custom tag purpose

Example: "Used for marking important items"

{
  "id": "019a5522-76d2-7de4-b93b-aeb9306e2fef",
  "timestamp_created": "2025-11-05T17:48:33.362Z",
  "timestamp_updated": "2025-11-05T17:48:33.362Z",
  "organization_id": "019a5522-76d2-7de4-b93b-aeba2a101d4a",
  "label": "Important",
  "description": "Used for marking important items"
}

Block List Entry

A blocked email or domain

idstring(uuid)read-onlyrequired

Unique identifier for the block list entry

Example: "019a5522-76d5-7241-b1b9-460c435ecbe6"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the block list entry was created

Example: "2025-11-05T17:48:33.366Z"

organization_idstring(uuid)read-onlyrequired

Organization ID that owns this block list entry

Example: "019a5522-76d6-7f5b-aca5-b5f1662ae91d"

bl_valuestringrequired

The email or domain to block

Example: "example.com"

is_domainbooleanread-onlyrequired

Whether this entry blocks an entire domain

Example: true

{
  "id": "019a5522-76d5-7241-b1b9-460c435ecbe6",
  "timestamp_created": "2025-11-05T17:48:33.366Z",
  "organization_id": "019a5522-76d6-7f5b-aca5-b5f1662ae91d",
  "bl_value": "example.com",
  "is_domain": true
}