Sample - Box Platform API
PUT/comments/{comment_id}

Update a comment

Updates the message of an existing comment. Provide message in the request body when you want to replace the comment text, and use fields to control which attributes appear in the response.

2 parameters · 1 body field
comment_idstringrequired
The unique identifier of the comment to update.
fieldsarray<string>optional
A comma-separated list of response attributes to include; specifying this parameter returns the requested fields and the mini representation instead of the standard fields.

The optional comment properties to update.

messagestringoptional
The text of the comment to update.

2 status codes
200Returns the updated comment object.
idstringoptional
The unique identifier for this comment.
typestringoptional
The value will always be `comment`.
Allowed:comment
is_reply_commentbooleanoptional
Whether or not this comment is a reply to another comment.
messagestringoptional
The text of the comment, as provided by the user.
created_byobjectoptional
created_atstringoptional
The time this comment was created.
modified_atstringoptional
The time this comment was last modified.
itemobjectoptional
tagged_messagestringoptional
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.
defaultReturned when an unexpected client error occurs.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.

Error handling

comment_id must identify the comment you want to update. If you provide a request body, message must be a string. fields accepts a comma-separated list of string attributes and requests those attributes in addition to the mini representation.