Skip to main content
This schema describes objects returned by the Lead Label endpoints.

A custom label for categorizing and managing leads

id
string<uuid>
required
read-only

Unique identifier for the custom lead label

Example:

"01a06dae-4d6c-744b-8020-003a72e8498c"

timestamp_created
string<date-time>
required
read-only

Timestamp when the custom lead label was created

Example:

"2026-09-04T18:28:54.764Z"

created_by
string<uuid>
required
read-only

User ID of the creator of this label

Example:

"01a06dae-4d6c-744b-8020-003bb5e00abb"

organization_id
string<uuid>
required
read-only

Organization ID that owns this custom lead label

Example:

"01a06dae-4d6c-744b-8020-003c236bc557"

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

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