Update a label

​

Path Parameters

  • labelId
    Type: integer
    required

    ID of label

Body·

required
application/json

Label - array of values to be updated

  • color
    Type: string
    required

    Color of this label

  • name
    Type: string
    required

    Name of this label

  • module
    Type: string

    Name of the module this label can be attached to. When set, the label can only be attached to records of this module. Leave empty to allow any module (subject to per-space restrictions in spaces).

  • spaces
    Type: object

    Spaces this label is assigned to, and the optional per-space module restriction. Keys are space IDs; each value is an array of module names (in dash syntax) the label may be attached to within that space, or an empty array / null to allow all modules in that space. An empty spaces object makes the label global - visible to every space and every user.

    Properties: 1
  • type
    Type: string

    Scope of this label. SHARED labels are visible to all users with access to the assigned spaces; a SHARED label with no spaces is global and visible to everyone.

Responses

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for put/label/{labelId}
curl https://test.boost.space/api/label/1 \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "id": 42,
  "created": "2026-01-15T09:30:00Z",
  "createdUserId": 42,
  "updated": "2026-01-15T09:30:00Z",
  "updatedUserId": 42,
  "spaces": {
    "12": [
      "contact",
      "todo"
    ],
    "34": []
  },
  "name": "Sample name",
  "color": "#1f6feb",
  "type": "string",
  "module": "string",
  "editable": true
}'

{
  "id": 42,
  "created": "2026-01-15T09:30:00Z",
  "createdUserId": 42,
  "updated": "2026-01-15T09:30:00Z",
  "updatedUserId": 42,
  "spaces": {
    "12": [
      "contact",
      "todo"
    ],
    "34": []
  },
  "name": "Sample name",
  "color": "#1f6feb",
  "type": "string",
  "module": "string",
  "editable": true
}

Label updated record

Previous
Get a label by ID
Next
Delete a label