Add Comment On Document

POST

https://api.staple.io/v2/comments/add/document/:documentId

POST

/v2/comments/add/document/:documentId

$ curl -X POST https://api.staple.io/v2/comments/add/document/documentId \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json"

200Add Comment On Document

1 {
2   "createNotification": {
3     "createdAt": 1719979197937,
4     "id": "27776e3f-7594-4650-8526-3c2a32362502",
5     "info": {
6       "avatarURL": "https://staple-new-product-staging.s3.ap-southeast-1.amazonaws.com/avatar/reJjztoVJcC0jwqvtn0kW6W2un3oTHWI-tqg.png?AWSAccessKeyId=AKIATO6YT43ITVHQOBII&Expires=1719979497&Signature=joM2mxpHaON0w483I00GAa1u4r0%3D&response-content-disposition=inline%3B%20filename%3D%22avatar%2FreJjztoVJcC0jwqvtn0kW6W2un3oTHWI-tqg.png%22&response-content-type=image%2Fpng",
7       "email": "sender@gmail.com",
8       "firstName": "Ash",
9       "lastName": "Ketchum",
10       "role": "Owner",
11       "roleColor": null
12     },
13     "message": "Message comment",
14     "read": false,
15     "receivers": [
16       {
17         "createdAt": 1719979197906,
18         "id": "09109efb-ec6d-4bb3-92c5-7a7cc646df40",
19         "info": {
20           "avatarURL": "",
21           "email": "bhanuka@staple.io",
22           "firstName": "Staple",
23           "lastName": "Employee",
24           "role": "Admin",
25           "roleColor": "#fe7d4a"
26         },
27         "read": false,
28         "receiver": 1
29       },
30       {
31         "createdAt": 1719979197906,
32         "id": "efdf03da-9001-4f77-9a07-f4fc22407b95",
33         "info": {
34           "avatarURL": "",
35           "email": "vvluc@staple.io",
36           "firstName": "Staple",
37           "lastName": "Employee",
38           "role": "Member",
39           "roleColor": "#5ab4ec"
40         },
41         "read": false,
42         "receiver": 2
43       }
44     ],
45     "sender": 10,
46     "timeSinceCreated": "less than 5 seconds ago"
47   }
48 }

This endpoint allows you to add a comment to a specific document identified by {documentId}. The request should be sent via an HTTP POST method to the specified URL.

Authentication

x-api-keystring

API key issued by Staple.

AuthorizationBearer

JWT obtained from the login endpoint.

Path parameters

documentIdstringRequired

Request

This endpoint expects an object.

receiverEmailslist of stringsOptional

messagestringOptional

Authentication

Path parameters

Request

Response