Archive a board
POST
/boards/{board}/archive
const url = 'https://projects.work.optidata.cloud/api/boards/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/archive \ --header 'Authorization: Bearer <token>'Archives the board and, recursively, all of its descendant boards. Requires archive permission (manage).
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”board
required
integer
Board id.
Responses
Section titled “Responses”The archived board (archived_at set).
Media typeapplication/json
A project (kanban board). Boards nest via parent_id.
object
id
integer
user_id
Owner user id.
integer | null
group_id
integer | null
cuid
Tenant/company identifier the board belongs to.
string
parent_id
Parent board id (null for root boards).
integer | null
name
string
description
string | null
icon
Emoji icon.
string | null
visibility
string
order_cards_by
Default card sort field for new columns.
string | null
order_cards_direction
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
{ "visibility": "private", "order_cards_direction": "asc"}Missing, invalid or expired bearer passport.
Media typeapplication/json
object
error
string
Example
{ "error": "JWT passport exception: Missing bearer token in request"}The authenticated user lacks the required board permission.
Media typeapplication/json
object
message
string
Example
{ "message": "This action is unauthorized."}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."}