Reorder the board's columns

PATCH

/boards/{board}/columns/order

curl --request PATCH \
  --url https://projects.work.optidata.cloud/api/boards/1/columns/order \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "columnsOrder": [ { "id": 302, "order": 1 }, { "id": 301, "order": 2 } ] }'

• Optiwork Projects API

Bulk-updates the position of the board’s columns. Every referenced id must belong to the board, otherwise the request fails with 400.

Authorizations

• bearerAuth

Parameters

Path Parameters

board

required

integer

Board id.

Request Body^required

Media typeapplication/json

object

columnsOrder

required

Array<object>

object

id

required

integer

order

required

integer

Example

{
  "columnsOrder": [
    {
      "id": 302,
      "order": 1
    },
    {
      "id": 301,
      "order": 2
    }
  ]
}

Responses

200

The applied order (echo of the request).

Media typeapplication/json

Array<object>

object

id

integer

order

integer

Example^generated

[
  {
    "id": 1,
    "order": 1
  }
]

400

A referenced column does not belong to the board.

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

401

Missing, invalid or expired bearer passport.

Media typeapplication/json

object

error

string

Example

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

403

The authenticated user lacks the required board permission.

Media typeapplication/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.

Media typeapplication/json

object

message

string

Example

{
  "message": "Not found."
}

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