Add comment
- OpenAPI 3.1.0 document: https://api.rollstack.com/public/v1/openapi.json
- The whole reference in Markdown: https://docs.rollstack.com/llms-full.txt
- An index of the reference: https://docs.rollstack.com/llms.txt
POST https://api.rollstack.com/public/v1/reports/{id}/comments
Starts a comment thread on a slide of a report, or replies to a thread, as the user. A reply notifies the thread's other participants who can still open the report. Members who can comment on the report may.
Requires the slide_decks:write scope.
Operation ID: createReportComment.
Path parameters
id(string, required): The report to act on, by itsidfromlistReportsorcreateReport. Only reports whosetypeisSlideDeckwork here: another type, such as a Google Slides presentation, returns400. You can also copy it from the report's link in Rollstack: it's the part right after/slides/.
Headers
Idempotency-Key(string): A unique value, such as a UUID, that makes retrying this call safe. A retry with the same key within 24 hours answers the first call's result instead of running it again. Use a new key for each new call. From 1 to 255 printable ASCII characters.
Request body, required
application/json
text(string, required): The comment, as plain text: each line becomes a paragraph, and Markdown marks such as**and#are removed. Mentions and @Rollstack requests can only be written in the app. At most 5000 characters. Example:Updated the EMEA numbers on this slide..slideId(string): The slide to start a new thread on, asslideIdingetReportContent. Leave it out withthreadId.threadId(string): The thread to reply to, by its first comment'sidfromlistReportComments. The reply goes on the thread's slide, and the thread's other participants are notified.
Response 201
Success
application/json
id(string, required): Unique identifier for the comment. Pass a thread's first comment's id asthreadIdto reply to it, or toresolveReportComment.threadId(string or null, required): The thread the comment replies to, by its first comment'sid.nullfor the comment that starts a thread.slideId(string, required): The slide the thread is on, asslideIdingetReportContent.text(string, required): What the comment says, as plain text: a mention reads as@and the name, and a request to the Rollstack Agent as@Rollstack.author(object, required): Who wrote it. A reply the Rollstack Agent posted names the member who asked it.id(number, required): The member's user id, the same as theiridinlistMembers.name(string, required): The member's name, as shown in Rollstack.
byAgent(boolean, required): Whether the Rollstack Agent posted it, answering a comment that tagged @Rollstack.createdAt(string (date-time), required): When the comment was posted.resolvedAt(string (date-time) or null, required): When its thread was resolved. Only a thread's first comment has it;nullwhile the thread is open.resolvedBy(object or null, required): Who resolved the thread.nullwhile it is open.id(number, required): The member's user id, the same as theiridinlistMembers.name(string, required): The member's name, as shown in Rollstack.