PUT/boards/{boardId}/posts/{postId}

Updates a post.
HTML scripts are not allowed for security purposes.

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}/posts/{postId}

Path Parameters

ParameterTypeDescription
boardId integer 

Board ID


required
example : 100
format : int64 
postId integer 

Post ID


required
example : 1
format : int64 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
title string 

Subject


required
minLength : 1
maxLength : 200 
body string 

Content


required
minLength : 1
maxLength : 716800 
enableComment boolean 

Indicates whether to enable comments.


default : true 
mustReadEndDate string 

Must-read end date (up to 30 days)


format : date 
sendNotifications boolean 

Indicates whether to notify when a post is created


default : true 

Request Example

example

1{2  "title": "Example title",3  "body": "<h1>Example</h1> Insert body here.",4  "enableComment": true,5  "mustReadEndDate": "2023-03-20",6  "sendNotifications": true7}

Response

HTTP 200

OK

PropertyTypeDescription
boardId integer 

Board no.


format : int64 
postId integer 

Post no.


format : int64 
title string 

Subject


required 
readCount integer 

Number of reads


format : int64 
commentCount integer 

Number of comments


format : int64 
fileCount integer 

Number of files


format : int64 
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 
isMustRead boolean 

Indicates whether the post must be read.

 
mustReadPeriod object (mustReadPeriod) 

Must-read period

 
body string 

Content (format: HTML)


required 
enableComment boolean 

Indicates whether to enable comments.

 
userId string 

readOnly : true
nullable : true 
userName string 

Author name


readOnly : true 

mustReadPeriod

PropertyTypeDescription
startDate string 

Must-read start date


format : date
readOnly : true 
endDate string 

Must-read end date


format : date 

Response Example

example

1{2  "boardId": 100,3  "postId": 1,4  "title": "Example title",5  "readCount": 0,6  "commentCount": 0,7  "fileCount": 0,8  "createdTime": "2022-10-28T17:26:35+09:00",9  "modifiedTime": "2022-10-28T17:26:35+09:00",10  "isMustRead": true,11  "mustReadPeriod": {12    "startDate": "2023-03-13",13    "endDate": "2023-03-20"14  },15  "body": "<h1>Example</h1> Insert body here.",16  "enableComment": true,17  "userId": "userf7da-f82c-4284-13e7-030f3b4c756x",18  "userName": "Susan Nielsen"19}

HTTP 307

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

HTTP 403

Forbidden