INinstantly
LeadLabel

Patch lead label

Changed on

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

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

Request

  • Base URL
    https://api.instantly.ai
  • URL
    https://api.instantly.ai/api/v2/lead-labels/{id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required
Example:01a19e6d-9236-785b-9217-5b0a9b00bd7b

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

User ID of the creator of this label. Null when the label was created by an API key or an internal service

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": "01a19e6d-50dc-7b8c-b452-aec97d1ef041",
  "timestamp_created": "2026-11-02T22:42:06.684Z",
  "created_by": "01a19e6d-50dc-7b8c-b452-aeca72d5513e",
  "organization_id": "01a19e6d-50dc-7b8c-b452-aecbfb5a889c",
  "label": "Hot Lead",
  "interest_status_label": "positive",
  "interest_status": 1,
  "description": "Used for marking high-priority leads",
  "access_grants": [
    {
      "user_id": "01a19e6d-50dc-7b8c-b452-aecc67aadc9e",
      "access_type": 2
    }
  ]
}

Changes

  • c781051105a8Revision changes
    • breaking

      the response property became nullable for the status

    • info

      added the optional property to the response with the status