Comment

Get information about, edit, or delete a comment.

Resource

1/chatter/comments/commentId

1/connect/communities/communityId/chatter/comments/commentId

Available version

23.0

Requires Chatter

Yes

HTTP methods

GET, DELETE, PATCH

PATCH is supported in version 34.0 and later.

Request body for PATCH

Root XML tag

<comment>

JSON example for editing a comment

1{   "body":{
2      "messageSegments":[
3         {
4            "type":"Text",
5            "text":"I am definitely going to check that out."
6         }
7      ]
8   }
9}

JSON example for attaching an existing file to a comment

1{ 
2   "body" : {
3      "messageSegments" : [
4        {
5           "text" : "FY14 Sales Projections",
6           "type" : "Text"
7        }
8      ]
9   },
10   "capabilities": {
11      "contentDocumentId":"069D00000001FHF"
12   }
13}

Properties

Name	Type	Description	Available Version
`attachment`	Depends on type.	Optional. Values are: Attachment Input: Existing Content Attachment Input: New File Upload As of version 32.0, use the `capabilities` property. Important	24.0–31.0
`body`	Message Body Input	The body of the comment. Feed item and comment bodies have a 10,000 character limit. Because this limit can change, we recommend that clients make a `describeSObjects()` call on the FeedItem or FeedComment object. To determine the maximum number of allowed characters, look at the length of the Body or CommentBody field. To edit this property in a comment, make a PATCH request to `/chatter/comments/commentId`. Editing comments is supported in version 34.0 and later. Rich text and inline images are supported in comment bodies in version 35.0 and later.	23.0
`capabilities`	Comment Capabilities Input	Capabilities of the comment, such as a file attachment	32.0

Name

Type

Description

Available Version

attachment

Depends on type.

Optional. Values are:

As of version 32.0, use the capabilities property.

Important

24.0–31.0

body

Message Body Input

The body of the comment.

Feed item and comment bodies have a 10,000 character limit. Because this limit can change, we recommend that clients make a describeSObjects() call on the FeedItem or FeedComment object. To determine the maximum number of allowed characters, look at the length of the Body or CommentBody field.

To edit this property in a comment, make a PATCH request to /chatter/comments/commentId. Editing comments is supported in version 34.0 and later.

Rich text and inline images are supported in comment bodies in version 35.0 and later.

23.0

capabilities

Comment Capabilities Input

Capabilities of the comment, such as a file attachment

32.0

Response body for GET and PATCH

Comment

Response body for DELETE

204: Successful Delete

Chatter REST API Developer Guide

Comment

See Also