Update comment

put
https://api.box.com/2.0
/comments/:comment_id

Update the message of a comment.

Request

application/json

Path Parameters

stringin pathrequired
12345

The ID of the comment.

Query Parameters

string arrayin queryoptional
id,type,name

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.

Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Request Body

stringin bodyoptional
Review completed!

The text of the comment to update

Response

application/jsonComment

Returns the updated comment object.

You can now try out some of our APIs live, right here in the documentation.
Log In

Request Example

cURL
curl -X PUT https://api.box.com/2.0/comments/12345 \
     -H "Authorization: Bearer <ACCESS_TOKEN>" \
     -H "Content-Type: application/json" \
     -d '{
       "message": "My New Message"
     }'
.NET
var requestParams = new BoxCommentRequest()
{
    Message = "New message"
};
BoxComment updatedComment = await client.CommentsManager.UpdateAsync(id: "11111", requestParams);
Java
BoxComment comment = new BoxComment(api, "id");
comment.changeMessage("An edited message.");
Python
edited_comment = client.comment(comment_id='98765').edit('If possible, please finish this by Friday!')
Node
client.comments.update('11111', {message: 'New message'})
    .then(comment => {
        /* comment -> {
            type: 'comment',
            id: '11111',
            is_reply_comment: false,
            message: 'New message',
            created_by: 
            { type: 'user',
                id: '22222',
                name: 'Example User',
                login: 'user@example.com' },
            created_at: '2012-12-12T11:25:01-08:00',
            item: { id: '33333', type: 'file' },
            modified_at: '2012-12-12T11:25:01-08:00' }
        */
    });

Response Example

{
  "id": 11446498,
  "type": "comment",
  "is_reply_comment": true,
  "message": "@Aaron Levie these tigers are cool!",
  "created_by": {
    "id": 11446498,
    "type": "user",
    "name": "Aaron Levie",
    "login": "ceo@example.com"
  },
  "created_at": "2012-12-12T10:53:43-08:00",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "item": {
    "id": 11446498
  },
  "tagged_message": "@[1234567:Aaron Levie] these tigers are cool!"
}