Comment (Full) - Box Dev Docs

{
  "id": "11446498",
  "type": "comment",
  "is_reply_comment": true,
  "message": "@Aaron Levie these tigers are cool!",
  "created_at": "2012-12-12T10:53:43-08:00",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "item": {
    "id": "11446498",
    "type": "file"
  },
  "tagged_message": "@[1234567:Aaron Levie] these tigers are cool!"
}

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

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.

Show child attributes

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.

Show child attributes

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!"

Comment (Base)

Comments

⌘I

Documentation Index