Skip to main content
POST
Create lead label

Authorizations

Authorization
string
header
required

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

Body

application/json

The Lead Label to create

The Lead Label to create

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"

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 Lead Label

A custom label for categorizing and managing leads

id
string<uuid>
required
read-only

Unique identifier for the custom lead label

Example:

"01a11c5e-c4b6-76f2-85c8-06af2cc0e38e"

timestamp_created
string<date-time>
required
read-only

Timestamp when the custom lead label was created

Example:

"2026-10-08T16:35:35.222Z"

created_by
null | string<uuid>
required
read-only

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

Example:

"01a11c5e-c4b6-76f2-85c8-06b0919ddb1b"

organization_id
string<uuid>
required
read-only

Organization ID that owns this custom lead label

Example:

"01a11c5e-c4b6-76f2-85c8-06b1cce82ce7"

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

access_grants
object[]
read-only

The access grants on this label, oldest first, each with the access type the member holds. Only present when resource ownership is enabled for the workspace.