v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB

LeadLabel

Patch lead label

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

patch/api/v2/lead-labels/{id}

Path parameters

idstring uuid required

Example:019f94cd-aed2-76e1-8793-43fb69371dfb

The ID of the item to update

Request body

labelstring

Display label for the custom lead label

interest_status_label'positive' | 'negative' | 'neutral'

Interest status label associated with this label

descriptionstring nullable

Detailed description of the custom lead label purpose

use_with_aiboolean nullable

Whether this label should be used with AI features

Example request

{
  "label": "Hot Lead",
  "interest_status_label": "positive",
  "description": "Used for marking high-priority leads"
}

Response

The updated Lead Label

idstring uuid required

Unique identifier for the custom lead label

timestamp_createdstring date-time required

Timestamp when the custom lead label was created

created_bystring uuid required

User ID of the creator of this label

organization_idstring uuid required

Organization ID that owns this custom lead label

labelstring required

Display label for the custom lead label

interest_status_label'positive' | 'negative' | 'neutral' required

Interest status label associated with this label

interest_statusnumber required

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

descriptionstring nullable

Detailed description of the custom lead label purpose

use_with_aiboolean nullable

Whether this label should be used with AI features

Example response

{
  "id": "019f94cd-83e0-7429-94c8-21a0dd9220c8",
  "timestamp_created": "2026-07-24T15:45:24.448Z",
  "created_by": "019f94cd-83e0-7429-94c8-21a15cab7bb9",
  "organization_id": "019f94cd-83e0-7429-94c8-21a2305531f8",
  "label": "Hot Lead",
  "interest_status_label": "positive",
  "interest_status": 1,
  "description": "Used for marking high-priority leads"
}