POST https://chatloka.net/api/v1/labels

Create Label

Create a new label.

Required scope: labels:write

How to Use This Endpoint

1. Authentication

Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Body Parameters

Field	Type	Required	Description
`name`	`string`	Required	Label name (max 255, unique in org)
`color`	`string`	Optional	Hex color code (e.g. #F59E0B)
`description`	`string`	Optional	Description (max 500)
`sort_order`	`integer`	Optional	Sort order (min 0)

Request Body

application/json

{ "name": "VIP", "color": "#F59E0B", "description": "Very important customers" }

Example Request

bash

curl -X POST 'https://chatloka.net/api/v1/labels' \
  -H 'Authorization: Bearer $API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "VIP", "color": "#F59E0B", "description": "Very important customers" }'

Response

201 Created

application/json

{ "success": true, "data": { "id": 1, "name": "VIP", "slug": "vip", "color": "#F59E0B", "description": "Very important customers", "sort_order": 0, "is_system": false, "created_by": { "id": 5, "name": "Jane Smith", "email": "jane@acme.com" }, "created_at": "2026-07-14T10:30:00+00:00", "updated_at": "2026-07-14T10:30:00+00:00" } }

Error Responses

401 UNAUTHORIZED

{ "success": false, "error": { "code": "UNAUTHORIZED", "message": "Invalid or revoked API key" } }

403 FORBIDDEN

{ "success": false, "error": { "code": "FORBIDDEN", "message": "You do not have permission to access this resource." } }

422 VALIDATION_ERROR

{ "success": false, "error": { "code": "VALIDATION_ERROR", "message": "The given data was invalid.", "details": { "field": ["The field is required."] } } }

429 RATE_LIMIT_EXCEEDED

{ "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please slow down.", "retry_after": 60 } }

Back to Labels

Get Label Stats Update Label

🍪 We use cookies

We use cookies and similar technologies to improve your experience, analyze traffic, and personalize content. By clicking "Accept All", you consent to our use of cookies. Privacy Policy & Cookie Policy.

Cookie Preferences

Choose which cookies you want to allow. Essential cookies are always required for the website to function.

Essential Cookies

Required for the website to function. Cannot be disabled.

Always On

Analytics Cookies

Help us understand how visitors interact with our website by collecting anonymous data.

Marketing Cookies

Used to track visitors across websites to display relevant advertisements.

✅ Preferences saved!