provider Comments POST /v1/files/{file_key}/comments
@utdk/figma /v1/files/{file_key}/comments
Add a comment to a file
Posts a new comment on the file.
file_key path required
File to add comments in. This can be a file key or branch key. Use `GET /v1/files/:key` with the `branch_data` query param to get the branch key.
string

Try it

Authentication
Configure credentials for Figma API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

postcomment
POST/v1/files/{file_key}/comments
Posts a new comment on the file.

Parameters

required

File to add comments in. This can be a file key or branch key. Use `GET /v1/files/:key` with the `branch_data` query param to get the branch key.

Input

required

The text contents of the comment to post.

The ID of the comment to reply to, if any. This must be a root comment. You cannot reply to other replies (a comment that has a parent_id).

The position where to place the comment.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import figma from '@utdk/figma';

await figma.postcomment()