Lead Label
/
Delete lead label

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

Lead Label

A custom label for categorizing and managing leads

Operations

Lead Label

A custom label for categorizing and managing leads

idstring(uuid)read-onlyrequired

Unique identifier for the custom lead label

Example: "0199f36c-d715-7d47-bf95-f1626b43ea03"
timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the custom lead label was created

Example: "2025-10-17T18:27:00.501Z"
created_bystring(uuid)read-onlyrequired

User ID of the creator of this label

Example: "0199f36c-d715-7d47-bf95-f163e8f9fc46"
organization_idstring(uuid)read-onlyrequired

Organization ID that owns this custom lead label

Example: "0199f36c-d715-7d47-bf95-f164c0f957b1"
labelstringrequired

Display label for the custom lead label

Example: "Hot Lead"
interest_status_labelstringrequired

Interest status label associated with this label

Enum ValueDescription
positive

Positive

negative

Negative

neutral

Neutral

Example: "positive"
interest_statusnumberread-onlyrequired

Interest status associated with this label. This is generated automatically by us.

Example: 1
descriptionnull or string

Detailed description of the custom lead label purpose

Example: "Used for marking high-priority leads"
use_with_ainull or boolean

Whether this label should be used with AI features

Example: false
{
  "id": "0199f36c-d715-7d47-bf95-f1626b43ea03",
  "timestamp_created": "2025-10-17T18:27:00.501Z",
  "created_by": "0199f36c-d715-7d47-bf95-f163e8f9fc46",
  "organization_id": "0199f36c-d715-7d47-bf95-f164c0f957b1",
  "label": "Hot Lead",
  "interest_status_label": "positive",
  "interest_status": 1,
  "description": "Used for marking high-priority leads",
  "use_with_ai": false
}

Create lead label

Request

Requires one of the following scopes: lead-labels:create, lead-labels:all, all:create, all:all

Bodyapplication/jsonrequired

The Lead Label to create

labelstringrequired

Display label for the custom lead label

Example: "Hot Lead"
interest_status_labelstringrequired

Interest status label associated with this label

Enum ValueDescription
positive

Positive

negative

Negative

neutral

Neutral

Example: "positive"
descriptionstring or null

Detailed description of the custom lead label purpose

Example: "Used for marking high-priority leads"
use_with_aiboolean or null

Whether this label should be used with AI features

Example: false
curl -i -X POST \
  https://api.instantly.ai/api/v2/lead-labels \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "label": "Hot Lead",
    "interest_status_label": "positive"
  }'

Responses

The Lead Label

Bodyapplication/json
idstring(uuid)read-onlyrequired

Unique identifier for the custom lead label

Example: "0199f36c-d715-7d47-bf95-f1626b43ea03"
timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the custom lead label was created

Example: "2025-10-17T18:27:00.501Z"
created_bystring(uuid)read-onlyrequired

User ID of the creator of this label

Example: "0199f36c-d715-7d47-bf95-f163e8f9fc46"
organization_idstring(uuid)read-onlyrequired

Organization ID that owns this custom lead label

Example: "0199f36c-d715-7d47-bf95-f164c0f957b1"
labelstringrequired

Display label for the custom lead label

Example: "Hot Lead"
interest_status_labelstringrequired

Interest status label associated with this label

Enum ValueDescription
positive

Positive

negative

Negative

neutral

Neutral

Example: "positive"
interest_statusnumberread-onlyrequired

Interest status associated with this label. This is generated automatically by us.

Example: 1
descriptionnull or string

Detailed description of the custom lead label purpose

Example: "Used for marking high-priority leads"
use_with_ainull or boolean

Whether this label should be used with AI features

Example: false
Response
application/json
{
  "id": "0199f36c-d715-7d47-bf95-f1626b43ea03",
  "timestamp_created": "2025-10-17T18:27:00.501Z",
  "created_by": "0199f36c-d715-7d47-bf95-f163e8f9fc46",
  "organization_id": "0199f36c-d715-7d47-bf95-f164c0f957b1",
  "label": "Hot Lead",
  "interest_status_label": "positive",
  "interest_status": 1,
  "description": "Used for marking high-priority leads",
  "use_with_ai": false
}

List lead label

Request

Requires one of the following scopes: lead-labels:read, lead-labels:all, all:read, all:all

Query
limitinteger[ 1 .. 100 ]

The number of items to return

Example: limit=10
starting_afterstring

The starting after timestamp to filter lead labels by.

Example: starting_after=2025-03-07T00:00:00.000Z
searchstring

The search query to filter lead labels.

Example: search=Hot Lead
interest_statusstring

The interest status to filter lead labels by.

Enum"positive""neutral""negative"
Example: interest_status=positive
curl -i -X GET \
  'https://api.instantly.ai/api/v2/lead-labels?interest_status=positive&limit=10&search=Hot%20Lead&starting_after=2025-03-07T00%3A00%3A00.000Z' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The list of Lead Label

Bodyapplication/json
itemsArray of objects(Lead Label)required

The list of Lead Label

items[].​idstring(uuid)read-onlyrequired

Unique identifier for the custom lead label

Example: "0199f36c-d715-7d47-bf95-f1626b43ea03"
items[].​timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the custom lead label was created

Example: "2025-10-17T18:27:00.501Z"
items[].​created_bystring(uuid)read-onlyrequired

User ID of the creator of this label

Example: "0199f36c-d715-7d47-bf95-f163e8f9fc46"
items[].​organization_idstring(uuid)read-onlyrequired

Organization ID that owns this custom lead label

Example: "0199f36c-d715-7d47-bf95-f164c0f957b1"
items[].​labelstringrequired

Display label for the custom lead label

Example: "Hot Lead"
items[].​interest_status_labelstringrequired

Interest status label associated with this label

Enum ValueDescription
positive

Positive

negative

Negative

neutral

Neutral

Example: "positive"
items[].​interest_statusnumberread-onlyrequired

Interest status associated with this label. This is generated automatically by us.

Example: 1
items[].​descriptionnull or string

Detailed description of the custom lead label purpose

Example: "Used for marking high-priority leads"
items[].​use_with_ainull or boolean

Whether this label should be used with AI features

Example: false
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: "0199f36c-f71a-7161-b9a9-687e4d5ab80c"
Response
application/json
{
  "items": [
    { … }
  ],
  "next_starting_after": "0199f36c-f71a-7161-b9a9-687e4d5ab80c"
}

Get lead label

Request

Requires one of the following scopes: lead-labels:read, lead-labels:all, all:read, all:all

Path
idstring(uuid)required

The ID of the requested item

Example: 0199f36c-f71a-7161-b9a9-687f755c3920
curl -i -X GET \
  https://api.instantly.ai/api/v2/lead-labels/0199f36c-f71a-7161-b9a9-687f755c3920 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The requested Lead Label

Bodyapplication/json
idstring(uuid)read-onlyrequired

Unique identifier for the custom lead label

Example: "0199f36c-d715-7d47-bf95-f1626b43ea03"
timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the custom lead label was created

Example: "2025-10-17T18:27:00.501Z"
created_bystring(uuid)read-onlyrequired

User ID of the creator of this label

Example: "0199f36c-d715-7d47-bf95-f163e8f9fc46"
organization_idstring(uuid)read-onlyrequired

Organization ID that owns this custom lead label

Example: "0199f36c-d715-7d47-bf95-f164c0f957b1"
labelstringrequired

Display label for the custom lead label

Example: "Hot Lead"
interest_status_labelstringrequired

Interest status label associated with this label

Enum ValueDescription
positive

Positive

negative

Negative

neutral

Neutral

Example: "positive"
interest_statusnumberread-onlyrequired

Interest status associated with this label. This is generated automatically by us.

Example: 1
descriptionnull or string

Detailed description of the custom lead label purpose

Example: "Used for marking high-priority leads"
use_with_ainull or boolean

Whether this label should be used with AI features

Example: false
Response
application/json
{
  "id": "0199f36c-d715-7d47-bf95-f1626b43ea03",
  "timestamp_created": "2025-10-17T18:27:00.501Z",
  "created_by": "0199f36c-d715-7d47-bf95-f163e8f9fc46",
  "organization_id": "0199f36c-d715-7d47-bf95-f164c0f957b1",
  "label": "Hot Lead",
  "interest_status_label": "positive",
  "interest_status": 1,
  "description": "Used for marking high-priority leads",
  "use_with_ai": false
}

Patch lead label

Request

Requires one of the following scopes: lead-labels:update, lead-labels:all, all:update, all:all

Path
idstring(uuid)required

The ID of the item to update

Example: 0199f36c-f71b-74d7-a201-fdbf0b1f3424
Bodyapplication/json
non-empty
labelstring

Display label for the custom lead label

Example: "Hot Lead"
interest_status_labelstring

Interest status label associated with this label

Enum ValueDescription
positive

Positive

negative

Negative

neutral

Neutral

Example: "positive"
descriptionstring or null

Detailed description of the custom lead label purpose

Example: "Used for marking high-priority leads"
use_with_aiboolean or null

Whether this label should be used with AI features

Example: false
curl -i -X PATCH \
  https://api.instantly.ai/api/v2/lead-labels/0199f36c-f71b-74d7-a201-fdbf0b1f3424 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

The updated Lead Label

Bodyapplication/json
idstring(uuid)read-onlyrequired

Unique identifier for the custom lead label

Example: "0199f36c-d715-7d47-bf95-f1626b43ea03"
timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the custom lead label was created

Example: "2025-10-17T18:27:00.501Z"
created_bystring(uuid)read-onlyrequired

User ID of the creator of this label

Example: "0199f36c-d715-7d47-bf95-f163e8f9fc46"
organization_idstring(uuid)read-onlyrequired

Organization ID that owns this custom lead label

Example: "0199f36c-d715-7d47-bf95-f164c0f957b1"
labelstringrequired

Display label for the custom lead label

Example: "Hot Lead"
interest_status_labelstringrequired

Interest status label associated with this label

Enum ValueDescription
positive

Positive

negative

Negative

neutral

Neutral

Example: "positive"
interest_statusnumberread-onlyrequired

Interest status associated with this label. This is generated automatically by us.

Example: 1
descriptionnull or string

Detailed description of the custom lead label purpose

Example: "Used for marking high-priority leads"
use_with_ainull or boolean

Whether this label should be used with AI features

Example: false
Response
application/json
{
  "id": "0199f36c-d715-7d47-bf95-f1626b43ea03",
  "timestamp_created": "2025-10-17T18:27:00.501Z",
  "created_by": "0199f36c-d715-7d47-bf95-f163e8f9fc46",
  "organization_id": "0199f36c-d715-7d47-bf95-f164c0f957b1",
  "label": "Hot Lead",
  "interest_status_label": "positive",
  "interest_status": 1,
  "description": "Used for marking high-priority leads",
  "use_with_ai": false
}

Delete lead label

Request

Requires one of the following scopes: lead-labels:delete, lead-labels:all, all:delete, all:all

Path
idstring(uuid)required

The ID of the item to delete

Example: 0199f36c-f71c-7655-a9d3-47f319b86134
Bodyapplication/json
reassigned_statusnumber

The interest status to reassign leads and emails to.

Example: 1
curl -i -X DELETE \
  https://api.instantly.ai/api/v2/lead-labels/0199f36c-f71c-7655-a9d3-47f319b86134 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

The deleted Lead Label

Bodyapplication/json
idstring(uuid)read-onlyrequired

Unique identifier for the custom lead label

Example: "0199f36c-d715-7d47-bf95-f1626b43ea03"
timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the custom lead label was created

Example: "2025-10-17T18:27:00.501Z"
created_bystring(uuid)read-onlyrequired

User ID of the creator of this label

Example: "0199f36c-d715-7d47-bf95-f163e8f9fc46"
organization_idstring(uuid)read-onlyrequired

Organization ID that owns this custom lead label

Example: "0199f36c-d715-7d47-bf95-f164c0f957b1"
labelstringrequired

Display label for the custom lead label

Example: "Hot Lead"
interest_status_labelstringrequired

Interest status label associated with this label

Enum ValueDescription
positive

Positive

negative

Negative

neutral

Neutral

Example: "positive"
interest_statusnumberread-onlyrequired

Interest status associated with this label. This is generated automatically by us.

Example: 1
descriptionnull or string

Detailed description of the custom lead label purpose

Example: "Used for marking high-priority leads"
use_with_ainull or boolean

Whether this label should be used with AI features

Example: false
Response
application/json
{
  "id": "0199f36c-d715-7d47-bf95-f1626b43ea03",
  "timestamp_created": "2025-10-17T18:27:00.501Z",
  "created_by": "0199f36c-d715-7d47-bf95-f163e8f9fc46",
  "organization_id": "0199f36c-d715-7d47-bf95-f164c0f957b1",
  "label": "Hot Lead",
  "interest_status_label": "positive",
  "interest_status": 1,
  "description": "Used for marking high-priority leads",
  "use_with_ai": false
}

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

Schemas