This schema describes objects returned by the Lead Label endpoints.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Unique identifier for the custom lead label (read-only) |
timestamp_created | string (date-time) | Yes | Timestamp when the custom lead label was created (read-only) |
created_by | string (uuid) | Yes | User ID of the creator of this label (read-only) |
organization_id | string (uuid) | Yes | Organization ID that owns this custom lead label (read-only) |
label | string | Yes | Display label for the custom lead label |
interest_status_label | string | Yes | Interest status label associated with this label. Possible values: positive (Positive), negative (Negative), neutral (Neutral) |
interest_status | number | Yes | Interest status associated with this label. This is generated automatically by us. (read-only) |
description | string, nullable | No | Detailed description of the custom lead label purpose |
use_with_ai | boolean, nullable | No | Whether this label should be used with AI features |