PUT/boards/{boardId}

Updates a board.
This API operation requires board administrator permissions.
It cannot update the role, administrators, type, and template of a board.

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

Scope

board

HTTP Request

PUThttps://www.worksapis.com/v1.0/boards/{boardId}

Path Parameters

ParameterTypeDescription
boardId integer 

Board ID


required
example : 100
format : int64 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
boardName string 

Subject


required
minLength : 1
maxLength : 60 
description string 

Description


maxLength : 300 

Request Example

example

1{2  "boardName": "Notice",3  "description": "Notice Description"4}

Response

HTTP 200

OK

PropertyTypeDescription
boardId integer 

Board no.


required
format : int64 
boardName string 

Subject


required 
description string 

Description

 
createdTime string 

Creation time

  • Format: YYYY-MM-DDThh:mm:ssTZD

required
format : date-time
readOnly : true 
modifiedTime string 

Update time

  • Format: YYYY-MM-DDThh:mm:ssTZD

format : date-time
readOnly : true 
displayOrder integer 

Display order


required
format : int32
readOnly : true 

Response Example

example

1{2  "boardId": 100,3  "boardName": "Notice",4  "description": "Notice Description",5  "createdTime": "2022-10-28T17:26:35+09:00",6  "modifiedTime": "2022-10-28T17:26:35+09:00",7  "displayOrder": 18}

HTTP 307

Temporary redirect.
A resource that exists in another instance.
Returns the requested URL in the Location header.

HTTP 403

Forbidden