Sign in

v1

latestOpenAPI 3.1.02026-07-1744202324.0 KB
Comments

Add a comment to a file

Posts a new comment on the file.

post/v1/files/{file_key}/comments

Path parameters

file_keystring 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.

Request body

messagestring required

The text contents of the comment to post.

comment_idstring

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).

Response

Response from the POST /v1/files/{file_key}/comments endpoint.

idstring required

Unique identifier for comment.

file_keystring required

The file in which the comment lives

parent_idstring

If present, the id of the comment to which this is the reply

created_atstring date-time required

The UTC ISO 8601 time at which the comment was left

resolved_atstring date-time nullable

If set, the UTC ISO 8601 time the comment was resolved

messagestring required

The content of the comment

order_idstring nullable required

Only set for top level comments. The number displayed with the comment in the UI