Archive a column

POST

/boards/{board}/columns/{column}/archive

const url = 'https://projects.work.optidata.cloud/api/boards/1/columns/1/archive';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://projects.work.optidata.cloud/api/boards/1/columns/1/archive \
  --header 'Authorization: Bearer <token>'

Archives the column (and hides its cards from the active board view).

Authorizations

bearerAuth

Parameters

Path Parameters

board

required

integer

Board id.

column

required

integer

Column id (must belong to the board).

Responses

200

The archived column.

application/json

A task list within a board.

object

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

Missing, invalid or expired bearer passport.

application/json

object

error

string

Example

{
  "error": "JWT passport exception: Missing bearer token in request"
}

403

The authenticated user lacks the required board permission.

application/json

object

message

string

Example

{
  "message": "This action is unauthorized."
}

404

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

application/json

object

message

string

Example

{
  "message": "Not found."
}