Skip to main content

Comments are messages created on files. Comments can be made independently or created as responses to other comments.

id
string

The unique identifier for this comment.

Example:

"11446498"

type
enum<string>

The value will always be comment.

Available options:
comment
Example:

"comment"

is_reply_comment
boolean

Whether or not this comment is a reply to another comment.

Example:

true

message
string

The text of the comment, as provided by the user.

Example:

"@Aaron Levie these tigers are cool!"

created_by
User (Mini) · object

A mini user object representing the author of the comment.

created_at
string<date-time>

The time this comment was created.

Example:

"2012-12-12T10:53:43-08:00"

modified_at
string<date-time>

The time this comment was last modified.

Example:

"2012-12-12T10:53:43-08:00"

item
Reference · object

The file this comment was placed on.

tagged_message
string

The string representing the comment text with @mentions included. @mention format is @[id:username] where id is user's Box ID and username is their display name.

Example:

"@[1234567:Aaron Levie] these tigers are cool!"