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

The author is not notified when a comment is updated.
Mentioning a user is not supported.
This API operation cannot update a comment containing a sticker.

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}/comments/{commentId}

Path Parameters

ParameterTypeDescription
boardId integer 

Board ID


required
example : 100
format : int64 
postId integer 

Post ID


required
example : 1
format : int64 
commentId integer 

Comment ID


required
example : 1
format : int64 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Request Body

PropertyTypeDescription
content string 

Content


required
minLength : 1
maxLength : 5000 

Request Example

example

1{2  "content": "Example content"3}

Response

HTTP 200

OK

PropertyTypeDescription
boardId integer 

Board no.


required
format : int64
readOnly : true 
postId integer 

Post no.


required
format : int64
readOnly : true 
commentId integer 

Comment no.


required
format : int64
readOnly : true 
content string 

Content


required 
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 
userId string 

Author ID.
It is empty if the author's account is deleted.


readOnly : true
nullable : true 
userName string 

Author name


required
readOnly : true 
hasReply boolean 

Indicates whether the comment has a reply.


default : false
readOnly : true 
hasAttachment boolean 

Indicates whether the comment has an attachment.


default : false
readOnly : true 
isDeleted boolean 

When the comment that has a reply is deleted.
The reply is not displayed if the comment is deleted.


default : false
readOnly : true 

Response Example

example

1{2  "boardId": 100,3  "postId": 1,4  "commentId": 1,5  "content": "Example content",6  "createdTime": "2022-10-28T17:26:35+09:00",7  "modifiedTime": "2022-10-28T17:26:35+09:00",8  "userId": "userf7da-f82c-4284-13e7-030f3b4c756x",9  "userName": "Susan Nielsen",10  "hasReply": false,11  "hasAttachment": false,12  "isDeleted": false13}