Skip to content
Optiwork API Docs

Update a column

PATCH
/boards/{board}/columns/{column}
curl --request PATCH \
  --url https://projects.work.optidata.cloud/api/boards/1/columns/1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "In review", "color": "#f59e0b" }'

Updates the column’s name, description, icon or color. Requires edit permission.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
board
required
integer

Board id.

column
required
integer

Column id (must belong to the board).

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
<= 80 characters
description
string | null
<= 300 characters
icon
string | null
<= 255 characters
color
string | null
Allowed values: #ef4444 #f97316 #f59e0b #84cc16 #10b981 #06b6d4 #3b82f6 #8b5cf6 #ec4899 #64748b
Example
{
  "name": "In review",
  "color": "#f59e0b"
}

Responses

Section titled “ Responses ”

200

Section titled “200”

The updated column.

Media typeapplication/json

A task list within a board.

object
id
integer
board_id
integer
name
string
<= 80 characters
description
string | null
<= 300 characters
icon
string | null
<= 255 characters
color

Column accent color (fixed palette).

string | null
Allowed values: #ef4444 #f97316 #f59e0b #84cc16 #10b981 #06b6d4 #3b82f6 #8b5cf6 #ec4899 #64748b
order

Position within the board.

integer
sort_order

Sticky automatic card sort applied to this column, when set.

string | null
archived_at
string | null format: date-time
created_at
string format: date-time
updated_at
string format: date-time
deleted_at
string | null format: date-time
Example
{
  "color": "#ef4444"
}

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."
    ]
  }
}