Unarchive a board

POST

/boards/{board}/unarchive

const url = 'https://projects.work.optidata.cloud/api/boards/1/unarchive';
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/unarchive \
  --header 'Authorization: Bearer <token>'

Restores an archived board and the descendants archived with it. If the board’s parent is still archived, the board is detached to root level.

Authorizations

bearerAuth

Parameters

Path Parameters

board

required

integer

Board id.

Responses

200

The restored board (archived_at null).

application/json

A project (kanban board). Boards nest via parent_id.

object

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

<= 80 characters

description

string | null

<= 600 characters

icon

Emoji icon.

string | null

visibility

string

Allowed values: private public

order_cards_by

Default card sort field for new columns.

string | null

order_cards_direction

string | null

Allowed values: asc desc

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

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