Task Labels

Create a task label

Add a label to the catalog with a name (unique in your company, case-insensitive: 409 task_label_name_in_use) and a color from the task palette.

post/companies/{company}/task-labels

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/task-labels
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

Headers

Idempotency-Keystring
Example:01928f10-7c0e-7c4a-9b7d-2f8a6e3c1d4b

Client-generated opaque key (up to 255 characters; UUID v7 recommended) that makes retries safe: the first response is cached and replayed for repeats without re-executing the mutation. Reusing a key with a different body returns 422 idempotency_key_reused; the values of secret fields (password, secret…) count as part of the body, so retrying with a corrected secret under the same key is a different request, never the replay of the earlier answer. See the Idempotency guide.

Factuarea-Versionstring date
Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Request body

namestring required

Label name, unique within the company ignoring case (1-60 characters).

colorstring required

Palette key or hexadecimal #RGB/#RRGGBB.

Response

Task label created successfully. The Location header contains the canonical URL of the newly created label.

Example response

{
  "data": {
    "id": "0193a4f2-9a64-7e55-8f96-8b0c2d4e6a01",
    "object": "task_label",
    "name": "Error",
    "color": "red",
    "tasks_count": 7,
    "created_at": "2026-06-02T09:20:00+02:00",
    "updated_at": "2026-06-02T09:20:00+02:00"
  }
}

Changes

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