---
title: "Create comment"
method: POST
path: "/comments"
tags: ["Comments"]
---

# Create comment

`POST /comments`

Adds a comment by the user to a specific file, or
as a reply to an other comment.

## Query parameters

- `fields` string[]

## Request body

- object
  - `message` string, required — The text of the comment. To mention a user, use the `tagged_message` parameter instead.
  - `tagged_message` string — The text of the comment, including `@[user_id:name]` somewhere in the message to mention another user, which will send them an email notification, letting them know they have been mentioned. The `user_id` is the target user's ID, where the `name` can be any custom phrase. In the Box UI this name will link to the user's profile. If you are not mentioning another user, use `message` instead.
  - `item` object, required — The item to attach the comment to.
    - `id` string, required — The ID of the item.
    - `type` 'file' | 'comment', required — The type of the item that this comment will be placed on.

## Response `201`

Returns the newly created comment object.

Not all available fields are returned by default. Use the
[fields](#parameter-fields) query parameter to explicitly request
any specific fields.

- CommentFull — Base representation of a comment.
  - `id` string — The unique identifier for this comment.
  - `type` 'comment' — The value will always be `comment`.
  - `is_reply_comment` boolean — Whether or not this comment is a reply to another comment.
  - `message` string — The text of the comment, as provided by the user.
  - `created_by` object — A mini user object representing the author of the comment.
    - `id` string, required — The unique identifier for this user.
    - `type` 'user', required — The value will always be `user`.
    - `name` string — The display name of this user.
    - `login` string, email — The primary email address of this user.
  - `created_at` string, date-time — The time this comment was created.
  - `modified_at` string, date-time — The time this comment was last modified.
  - `item` object — The file this comment was placed on.
    - `id` string — The unique identifier for this object.
    - `type` string — The type for this object.
  - `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.

## Other responses

- `default` — An unexpected client error.

---

[API](https://skmtc.net/box/apis/platform-api.md) · [All operations](https://skmtc.net/box/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/box/platform-api/revisions/ba8f087e1a4d/schema)