Labels

Create a label

Create a label. Single-team orgs auto-resolve team_id; multi-team orgs MUST pass it. Names are unique per team — duplicates return invalid_field_value.

post/labels

Request

  • Base URL: https://api.kirimdev.com/v1
  • URL: https://api.kirimdev.com/v1/labels
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Optional retry key. Reusing the same key with the same method, path, and body within 24 hours returns the original response; reusing it for a different request returns 422.

Example:order-20260910-0001

Request body

team_idstring
namestring required
color'gray' | 'red' | 'orange' | 'amber' | 'yellow' | 'lime' | 'green' | 'emerald' | 'teal' | 'sky' | 'blue' | 'violet' | 'pink'

Response

Label created

request_idstring required

Unique request identifier to include when contacting support.

Example response

{
  "data": {
    "id": "lbl_01HXYZABCDEFGHJKMNPQRSTVWX"
  },
  "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
}

Changes

No recorded changes to this operation across all 1 revision of this API.