Create comment with the Figma API

Posts a comment on a file as the connected user and returns it, or a reply when comment_id is sent. Without client_meta the comment is not pinned to a spot of the canvas. A posted comment cannot be edited, only deleted with Delete comment.

Identifier
figma_create_comment

The request

POST https://connect.reportei.com/api/tools/figma_create_comment/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "file_key": "<file_key>",
    "message": "<message>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
file_keystringYesKey of the file: the part after /design/, /file/ or /board/ in the URL of the file in Figma. The key of a branch also works.
messagestringYesText of the comment.
comment_idstringNoId of the comment to reply to, from List comments. It must be a root comment, one without parent_id: replies to replies are refused.
client_metaobjectNoWhere the comment goes. Send x and y for a spot of the canvas, or node_id and node_offset to attach it to a frame; add region_width and region_height to mark an area instead of a point. A reply takes no position.

Supported connections

Your customer connects their Figma account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/figma, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/figma_create_comment. It becomes your agent's tool definition with no conversion.

Other Figma tools

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.