Skip to main content

Resolve comment thread

POST https://api.rollstack.com/public/v1/reports/{id}/comments/{commentId}/resolve

Resolves a comment thread once what it asked for is done, or opens it again, as the user. Only a thread's first comment can be resolved. Members who can comment on the report may.

Requires the slide_decks:write scope.

Operation ID: resolveReportComment.

Path parameters

  • id (string, required): The report to act on, by its id from listReports or createReport. Only reports whose type is SlideDeck work here: another type, such as a Google Slides presentation, returns 400. You can also copy it from the report's link in Rollstack: it's the part right after /slides/.
  • commentId (string, required): The thread to act on, by its first comment's id from listReportComments, the one whose threadId is null.

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

  • resolved (boolean): true to resolve the thread, false to open it again. Defaults to true.

Response 200

Success

application/json

  • id (string, required): Unique identifier for the comment. Pass a thread's first comment's id as threadId to reply to it, or to resolveReportComment.
  • threadId (string or null, required): The thread the comment replies to, by its first comment's id. null for the comment that starts a thread.
  • slideId (string, required): The slide the thread is on, as slideId in getReportContent.
  • 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 their id in listMembers.
    • 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; null while the thread is open.
  • resolvedBy (object or null, required): Who resolved the thread. null while it is open.
    • id (number, required): The member's user id, the same as their id in listMembers.
    • name (string, required): The member's name, as shown in Rollstack.