POST/groups/{groupId}/note/posts

Creates a post.
HTML scripts are not allowed for security reasons.

Authorization

oauth2

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

Scope

group.note

HTTP Request

POSThttps://www.worksapis.com/v1.0/groups/{groupId}/note/posts

Path Parameters

ParameterTypeDescription
groupId string 

Team/group ID


required
example : group127-8545-4463-603b-04d550d23bf 

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 
enableCollaboration boolean 

Indicates whether to allow co-editing.


default : true 
sendNotifications boolean 

Indicates whether to notify when a post is added.


default : true 
isNotice boolean 

Indicates whether it is a notice.


default : false 

Request Example

example

1{2  "title": "How to use LINE WORKS",3  "body": "<h1> How to use LINE WORKS </h1> Follow the steps below...",4  "enableCollaboration": true,5  "sendNotifications": true,6  "isNotice": false7}

Response

HTTP 201

Created

PropertyTypeDescription
schema object (schema) 
 

schema

PropertyTypeDescription
postId integer 

Post no.


format : int64 
title string 

Subject


required
minLength : 1
maxLength : 200 
body string 

Content


required
minLength : 1
maxLength : 716800 
enableCollaboration boolean 

Indicates whether to allow co-editing.

 
readCount integer 

Number of reads


format : int64 
commentCount integer 

Number of comments


format : int64 
fileCount integer 

Number of files


format : int64 
likeCount integer 

Number of likes


format : int64 
createdTime string 

Creation time


required
format : date-time
readOnly : true 
modifiedTime string 

Update time


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 
isNotice boolean 

Indicates whether it is a notice.

 

Response Example

example

1{2  "postId": 1,3  "title": "How to use LINE WORKS",4  "body": "<h1> How to use LINE WORKS </h1> Follow the steps below...",5  "enableCollaboration": true,6  "readCount": 14,7  "commentCount": 2,8  "fileCount": 0,9  "likeCount": 1,10  "createdTime": "2019-08-24T14:15:22+09:00",11  "modifiedTime": "2019-08-24T14:15:22+09:00",12  "userId": "user7149-0ccd-433d-1eba-04f6901660dc",13  "userName": "Susan Nielsen",14  "isNotice": false15}

HTTP 403

Maximum post count was exceeded. Maximum file count was exceeded.