Boards

Update a board

POST/api/boards/{boardId}

Updates a board's name, description, or configuration and validates the resources and reports it references.

Headers

Name	Type	Description
Authorizationrequired	string	Authentication credentials, e.g. `Bearer <token>`.

Path parameters

Name	Type	Description
boardIdrequired	string	ID of the board.

Request body

Name	Type	Description
description	string	Description of the resource.
name	string	Display name of the resource.
parameters	object	Configuration parameters for the resource.
type	anyOf

Example request

{
  "description": "string",
  "name": "string",
  "parameters": {},
  "type": "string"
}

Responses

200The operation completed successfully.

Name	Type	Description
createdAtrequired	string	Date and time the record was created.
descriptionrequired	string	Description of the resource.
idrequired	string	Unique identifier of the resource.
namerequired	string	Display name of the resource.
parametersrequired	anyOf	Configuration parameters for the resource.

teamIdrequired	string	ID of the associated team.
typerequired	string
updatedAtrequired	string	Date and time the record was last updated.
userIdrequired	string	ID of the associated user.

200 example

{
  "createdAt": "2024-01-15T09:30:00Z",
  "description": "string",
  "id": "string",
  "name": "string",
  "parameters": "string",
  "teamId": "string",
  "type": "string",
  "updatedAt": "2024-01-15T09:30:00Z",
  "userId": "string"
}

400Bad request.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

400 example

{
  "error": {
    "code": "bad-request",
    "message": "Bad request.",
    "status": 400
  }
}

401Unauthorized.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

401 example

{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized.",
    "status": 401
  }
}

500Server error.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

500 example

{
  "error": {
    "code": "server-error",
    "message": "Server error.",
    "status": 500
  }
}

Code samples

cURL

curl -X POST 'https://api.example.com/api/boards/{boardId}' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "description": "string",
  "name": "string",
  "parameters": {},
  "type": "string"
}'

PreviousList shares for a board NextGet website breakdown