Skip to content
Optiwork API Docs

Change a board's visibility

PUT
/boards/{board}/visibility
curl --request PUT \
  --url https://projects.work.optidata.cloud/api/boards/1/visibility \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "visibility": "public" }'

Switches the board between private (members only) and public (all tenant users can view). Requires manage permission.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
board
required
integer

Board id.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
visibility
string
Allowed values: private public
Example
{
  "visibility": "public"
}

Responses

Section titled “ Responses ”

200

Section titled “200”

New visibility.

Media typeapplication/json
object
visibility
string
Allowed values: private public
Example
{
  "visibility": "public"
}

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