Skip to main content
PATCH
/
api
/
v2
/
lead-labels
/
{id}
Patch lead label
curl --request PATCH \
  --url https://api.instantly.ai/api/v2/lead-labels/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "Hot Lead",
  "interest_status_label": "positive",
  "description": "Used for marking high-priority leads",
  "use_with_ai": false
}
'
{
  "id": "019cc043-af6e-7fa4-8b42-a30be219beb4",
  "timestamp_created": "2026-03-05T23:09:47.246Z",
  "created_by": "019cc043-af6e-7fa4-8b42-a30ce4c822f9",
  "organization_id": "019cc043-af6e-7fa4-8b42-a30d392bb6f5",
  "label": "Hot Lead",
  "interest_status_label": "positive",
  "interest_status": 1,
  "description": "Used for marking high-priority leads",
  "use_with_ai": false
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<uuid>
required

The ID of the item to update

Example:

"019cc043-e382-76de-840e-a2d2450082cd"

Body

application/json
​
label
string

Display label for the custom lead label

Example:

"Hot Lead"

​
interest_status_label
enum<string>

Interest status label associated with this label

Available options:
positive,
negative,
neutral
Example:

"positive"

​
description
string | null

Detailed description of the custom lead label purpose

Example:

"Used for marking high-priority leads"

​
use_with_ai
boolean | null

Whether this label should be used with AI features

Example:

false

Response

The updated Lead Label

A custom label for categorizing and managing leads

​
id
string<uuid>
required

Unique identifier for the custom lead label

Example:

"019cc043-af6e-7fa4-8b42-a30be219beb4"

​
timestamp_created
string<date-time>
required

Timestamp when the custom lead label was created

Example:

"2026-03-05T23:09:47.246Z"

​
created_by
string<uuid>
required

User ID of the creator of this label

Example:

"019cc043-af6e-7fa4-8b42-a30ce4c822f9"

​
organization_id
string<uuid>
required

Organization ID that owns this custom lead label

Example:

"019cc043-af6e-7fa4-8b42-a30d392bb6f5"

​
label
string
required

Display label for the custom lead label

Example:

"Hot Lead"

​
interest_status_label
enum<string>
required

Interest status label associated with this label

Available options:
positive,
negative,
neutral
Example:

"positive"

​
interest_status
number
required

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

Example:

1

​
description
null | string

Detailed description of the custom lead label purpose

Example:

"Used for marking high-priority leads"

​
use_with_ai
null | boolean

Whether this label should be used with AI features

Example:

false