Figma · Schema

PostCommentRequest

Request body for posting a new comment.

CollaborationDesignGraphicsInterfacesPrototypesPrototypingUI/UX

Properties

Name Type Description
message string The text content of the comment.
comment_id string The comment to reply to, if any. This must be a root comment. Creating a reply to a reply is not supported.
View JSON Schema on GitHub

JSON Schema

figma-rest-post-comment-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "PostCommentRequest",
  "type": "object",
  "description": "Request body for posting a new comment.",
  "properties": {
    "message": {
      "type": "string",
      "description": "The text content of the comment."
    },
    "comment_id": {
      "type": "string",
      "description": "The comment to reply to, if any. This must be a root comment. Creating a reply to a reply is not supported."
    }
  }
}