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:

"019f985c-633c-79af-9e3f-cf5ef0caa408"

timestamp_created
string<date-time>
required
read-only

Timestamp when the custom lead label was created

Example:

"2026-07-25T08:20:19.389Z"

created_by
string<uuid>
required
read-only

User ID of the creator of this label

Example:

"019f985c-633d-7ac5-89c0-c31d05c98970"

organization_id
string<uuid>
required
read-only

Organization ID that owns this custom lead label

Example:

"019f985c-633d-7ac5-89c0-c31e9a4e39d6"

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