Boards

Update board

Updates a board. Project managers can update all fields, board members can only subscribe/unsubscribe.

patch/boards/{id}

Request

Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
URL: /api/boards/{id}
Auth: one of:
- HTTP bearer
- API key in header X-Api-Key

Path parameters

idstring required

Example:1357158568008091264

ID of the board to update

Request body

positionnumber

Position of the board within the project

namestring

Name/title of the board

defaultView'kanban' | 'grid' | 'list'

Default view for the board

defaultCardType'project' | 'story'

Default card type for new cards

limitCardTypesToDefaultOneboolean

Whether to limit card types to default one

alwaysDisplayCardCreatorboolean

Whether to always display card creators

expandTaskListsByDefaultboolean

Whether to expand task lists by default

isSubscribedboolean

Whether the current user is subscribed to the board

Example request

{
  "position": 65536,
  "name": "Development Board",
  "defaultView": "kanban",
  "defaultCardType": "project",
  "isSubscribed": true
}

Response

Board updated successfully

Example response

{
  "item": {
    "id": "1357158568008091264",
    "projectId": "1357158568008091265",
    "position": 65536,
    "name": "Development Board",
    "defaultView": "kanban",
    "defaultCardType": "project",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.