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

Audit Log

Audit log records for tracking system activities

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: "01967c97-63dc-7254-be15-2ba4c29798a6"

typestringrequired

Type of background job

Enum Value	Description
move-leads	Move Leads
import-leads	Import Leads
export-leads	Export Leads

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-04-28T13:30:18.460Z"

updated_atstringrequired

Timestamp when the job was last updated

Example: "2025-04-28T13:30:18.460Z"

user_idstring(uuid)read-only

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

Example: "01967c97-63dc-7254-be15-2ba5629debc6"

entity_idstring(uuid)

The id of the entity that the job is related to

Example: "01967c97-63dc-7254-be15-2ba6e5de9df9"

entity_typestring

Type of entity

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

Example: "list"

dataobject

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

{
  "id": "675266e304a8e55b17f0228b",
  "workspace_id": "01967c97-63dc-7254-be15-2ba4c29798a6",
  "user_id": "01967c97-63dc-7254-be15-2ba5629debc6",
  "type": "move-leads",
  "entity_id": "01967c97-63dc-7254-be15-2ba6e5de9df9",
  "entity_type": "list",
  "data": {},
  "progress": 0,
  "status": "pending",
  "created_at": "2025-04-28T13:30:18.460Z",
  "updated_at": "2025-04-28T13:30:18.460Z"
}

Custom Tag

A custom tag for organizing and categorizing items

idstring(uuid)read-onlyrequired

Unique identifier for the custom tag

Example: "01967c97-63dd-77f8-97d4-c7f32bd4c7a1"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the custom tag was created

Example: "2025-04-28T13:30:18.461Z"

timestamp_updatedstring(date-time)read-onlyrequired

Timestamp when the custom tag was last updated

Example: "2025-04-28T13:30:18.461Z"

organization_idstring(uuid)read-onlyrequired

Organization ID that owns this custom tag

Example: "01967c97-63dd-77f8-97d4-c7f437445ceb"

labelstringrequired

Display label for the custom tag

Example: "Important"

descriptionstring

Detailed description of the custom tag purpose

Example: "Used for marking important items"

{
  "id": "01967c97-63dd-77f8-97d4-c7f32bd4c7a1",
  "timestamp_created": "2025-04-28T13:30:18.461Z",
  "timestamp_updated": "2025-04-28T13:30:18.461Z",
  "organization_id": "01967c97-63dd-77f8-97d4-c7f437445ceb",
  "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: "01967c97-63e1-7e8f-98ce-e988f70fc6da"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the block list entry was created

Example: "2025-04-28T13:30:18.465Z"

organization_idstring(uuid)read-onlyrequired

Organization ID that owns this block list entry

Example: "01967c97-63e1-7e8f-98ce-e989c5b51a9c"

bl_valuestringrequired

The email or domain to block

Example: "example.com"

is_domainbooleanread-onlyrequired

Whether this entry blocks an entire domain

Example: true

{
  "id": "01967c97-63e1-7e8f-98ce-e988f70fc6da",
  "timestamp_created": "2025-04-28T13:30:18.465Z",
  "organization_id": "01967c97-63e1-7e8f-98ce-e989c5b51a9c",
  "bl_value": "example.com",
  "is_domain": true
}