Add Custom Lead Label

POST

https://api.plusvibe.ai/api/v1/workspace-settings/lead-labels/add

Creates a custom lead label. The label's stable key is generated from the name (letters/numbers kept, everything else becomes _, uppercased) — e.g. "Hot Lead" → HOT_LEAD.

Rules

The name (and its generated key) must not clash with a system label or an existing custom label in the workspace.

The name may not contain < or >; max 100 characters.

There is no edit endpoint — to change a label, delete it and create a new one.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Body Params application/json

Examples

Responses

🟢200OK

application/json

Created

Bodyapplication/json

🟠400Bad Request

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.plusvibe.ai/api/v1/workspace-settings/lead-labels/add' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "workspace_id": "6764274d64169c4e88eec418",
    "name": "Hot Lead",
    "sentiment": "POSITIVE"
}'

Response Example

200 - Success Example

{
    "status": "Success",
    "id": "68a1b2c3d4e5f6a7b8c9d0e1",
    "key": "HOT_LEAD",
    "name": "Hot Lead"
}

Modified at 2026-08-15 09:43:13

List Lead Labels

Delete Custom Lead Labels