Skip to content
Optiwork API Docs

Update a board tag

PATCH
/boards/{board}/tags/{tag}
curl --request PATCH \
  --url https://projects.work.optidata.cloud/api/boards/1/tags/1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "front-end", "color": "#22c55e" }'

Updates the tag’s name, color and/or description.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
board
required
integer

Board id.

tag
required
integer

Tag id.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
>= 2 characters <= 40 characters
color
required

Hex color.

string
description
string | null
>= 3 characters <= 250 characters
Example
{
  "name": "front-end",
  "color": "#22c55e"
}

Responses

Section titled “Responses”

200

Section titled “200”

The updated tag.

Media typeapplication/json
object
tag

A label. board_id null means a common (tenant-wide) tag.

object
id
integer
board_id
integer | null
name
string
>= 2 characters <= 40 characters
description
string | null
>= 3 characters <= 250 characters
color

Hex color (e.g. #52eb00).

string
created_at
string format: date-time
updated_at
string format: date-time
tag_list_item_html

Server-rendered HTML snippet for the Optiwork web client. Safe to ignore.

string
Examplegenerated
{
  "tag": {
    "id": 1,
    "board_id": 1,
    "name": "example",
    "description": "example",
    "color": "example",
    "created_at": "2026-04-15T12:00:00Z",
    "updated_at": "2026-04-15T12:00:00Z"
  },
  "tag_list_item_html": "example"
}

401

Section titled “401”

Missing, invalid or expired bearer passport.

Media typeapplication/json
object
error
string
Example
{
  "error": "JWT passport exception: Missing bearer token in request"
}

403

Section titled “403”

The authenticated user lacks the required board permission.

Media typeapplication/json
object
message
string
Example
{
  "message": "This action is unauthorized."
}

404

Section titled “404”

Resource not found, or a nested resource does not belong to its parent in the path.

Media typeapplication/json
object
message
string
Example
{
  "message": "Not found."
}

422

Section titled “422”

Validation failed.

Media typeapplication/json
object
message

First validation error message.

string
errors

Map of field name → list of error messages.

object
key
additional properties
Array<string>
Example
{
  "message": "The name field is required.",
  "errors": {
    "name": [
      "The name field is required."
    ]
  }
}