{ "opencollection": "1.0.0", "info": { "name": "Helpcenter AccountComments API", "version": "1.0.0" }, "items": [ { "info": { "name": "AccountComments", "type": "folder" }, "items": [ { "info": { "name": "Get an account comment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/accounts/:accountId/comments/:commentId", "params": [ { "name": "include", "value": "", "type": "query", "description": "Secondary information related to the comments. Value allowed is mentions, which returns the details of users mentioned in the comments." }, { "name": "accountId", "value": "", "type": "path" }, { "name": "commentId", "value": "", "type": "path" } ] }, "docs": "This API fetches an account comment from the portal." }, { "info": { "name": "Update an account comment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/accounts/:accountId/comments/:commentId", "params": [ { "name": "accountId", "value": "", "type": "path" }, { "name": "commentId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API updates an existing account comment." }, { "info": { "name": "Delete an account comment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/accounts/:accountId/comments/:commentId", "params": [ { "name": "accountId", "value": "", "type": "path" }, { "name": "commentId", "value": "", "type": "path" } ] }, "docs": "This API deletes an existing account comment." }, { "info": { "name": "List all account comments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/accounts/:accountId/comments", "params": [ { "name": "include", "value": "", "type": "query", "description": "Secondary information related to the comments. Value allowed is mentions, which returns the details of users mentioned in the comments." }, { "name": "limit", "value": "", "type": "query", "description": "No. of comments to fetch" }, { "name": "from", "value": "", "type": "query", "description": "Index number starting from which the comments must be fetched." }, { "name": "sortBy", "value": "", "type": "query", "description": "sortby can be @commentedTime@. default order : commentedTime in descending order , prefix @-@ denotes desc" }, { "name": "accountId", "value": "", "type": "path" } ] }, "docs": "This API lists a particular number of comments recorded on an account, based on the limit specified." }, { "info": { "name": "Create an account comment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/accounts/:accountId/comments", "params": [ { "name": "accountId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API adds a comment to an account." } ] } ], "bundled": true }