Skip to main content
POST
/
v1
/
labels
/
{id}
Error
A valid request URL is required to generate request examples
{
  "label_id": "label_d8aad64dib2c7m3ae7k0",
  "name": "q2-launches",
  "color": "#3b82f6",
  "icon": "rocket"
}

Authorizations

​
X-API-Key
string
header
required

Personal Access Token, sent verbatim as pat_<32 chars>. PATs are minted from the Chief settings UI.

Headers

​
X-Project-Id
string
required

Project identifier scoping the request. Required on every project-scoped public endpoint. Missing or malformed values respond with HTTP 400 and code publicapi.tenancy.project.missing.

Pattern: ^project_[a-z0-9]{20}$

Path Parameters

​
id
string
required

Label identifier.

Pattern: ^label_[a-z0-9]{20}$

Body

application/json

Patch a label's display metadata. Each field is optional; omitting one leaves it unchanged.

​
name
string
Required string length: 2 - 255
​
color
string

6-digit hex color (e.g. #3b82f6).

Pattern: ^#[0-9a-fA-F]{6}$
​
icon
string

Response

Label updated.

Full label view returned by get and update, including display metadata.

​
label_id
string
required
Pattern: ^label_[a-z0-9]{20}$
​
name
string
required
​
color
string

CSS color (e.g. #3b82f6). Omitted when unset.

​
icon
string

Icon identifier. Omitted when unset.