POST /v1/files/{file_key}/comments
Posts a new comment on the file.
Servers
- https://api.figma.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
file_key |
String | Yes |
File to add comments in. This can be a file key or branch key. Use |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
message |
String | Yes |
The text contents of the comment to post. |
comment_id |
String | No |
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). |
client_meta |
Object | No |
The position where to place the comment. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.