Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "body": {
# "messageSegments": [
# {
# "type": "Text",
# "text": "Editing a comment"
# }
# ]
# }
# }
json = Chilkat::CkJsonObject.new()
json.UpdateString("body.messageSegments[0].type","Text")
json.UpdateString("body.messageSegments[0].text","Editing a comment")
# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
http.SetRequestHeader("Content-Type","application/json")
sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)
# resp is a CkHttpResponse
resp = http.PTextSb("PATCH","https://domain.com/services/data/v{{version}}/chatter/comments/:COMMENT_ID",sbRequestBody,"utf-8","application/json",false,false)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Failed." + "\n";
exit
end
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "body": {
# "isRichText": false,
# "messageSegments": [
# {
# "text": "Editing a comment",
# "type": "Text"
# }
# ],
# "text": "Editing a comment"
# },
# "capabilities": {
# "edit": {
# "isEditRestricted": false,
# "isEditableByMeUrl": "/services/data/v58.0/chatter/comments/0D7.../capabilities/edit/is-editable-by-me",
# "lastEditedBy": {
# "additionalLabel": null,
# "communityNickname": "User1696423780773910041",
# "companyName": "Salesforce",
# "displayName": "Name",
# "firstName": "Firstname",
# "id": "005...",
# "isActive": true,
# "isInThisCommunity": true,
# "lastName": "Name",
# "motif": {
# "color": "1B96FF",
# "largeIconUrl": "/img/icon/profile64.png",
# "mediumIconUrl": "/img/icon/profile32.png",
# "smallIconUrl": "/img/icon/profile16.png",
# "svgIconUrl": null
# },
# "mySubscription": null,
# "name": "Name",
# "outOfOffice": {
# "message": ""
# },
# "photo": {
# "fullEmailPhotoUrl": "https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1",
# "largePhotoUrl": "https://<my_domain>/profilephoto/7292o000000oAgZ/F",
# "mediumPhotoUrl": "https://<my_domain>/profilephoto/7292o000000oAgZ/M",
# "photoVersionId": "729...",
# "smallPhotoUrl": "https://<my_domain>/profilephoto/7292o000000oAgZ/T",
# "standardEmailPhotoUrl": "https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1",
# "url": "/services/data/v58.0/connect/user-profiles/005.../photo"
# },
# "reputation": null,
# "title": null,
# "type": "User",
# "url": "/services/data/v58.0/chatter/users/005...",
# "userType": "Internal"
# },
# "lastEditedDate": "2023-11-22T11:22:36.000Z",
# "latestRevision": 2,
# "relativeLastEditedDate": "Just now"
# },
# "status": {
# "feedEntityStatus": "Published",
# "isApprovableByMe": true
# },
# "upDownVote": {
# "downVoteCount": 0,
# "myVote": "None",
# "upVoteCount": 0
# },
# "verified": {
# "isVerifiableByMe": false,
# "isVerified": false,
# "isVerifiedByAnonymized": null,
# "lastVerifiedByUser": null,
# "lastVerifiedDate": null
# }
# },
# "clientInfo": null,
# "createdDate": "2023-11-22T11:19:50.000Z",
# "feedElement": {
# "id": "0D5...",
# "url": "/services/data/v58.0/chatter/feed-elements/0D5..."
# },
# "id": "0D7...",
# "isDeleteRestricted": false,
# "likes": {
# "currentPageToken": null,
# "currentPageUrl": "/services/data/v58.0/chatter/comments/0D7.../likes",
# "items": [
# ],
# "nextPageToken": null,
# "nextPageUrl": null,
# "previousPageToken": null,
# "previousPageUrl": null,
# "total": 0
# },
# "likesMessage": null,
# "moderationFlags": null,
# "myLike": null,
# "parent": {
# "id": "005...",
# "url": "/services/data/v58.0/chatter/users/005..."
# },
# "relativeCreatedDate": "2m ago",
# "threadLevel": 0,
# "threadParentId": null,
# "type": "TextComment",
# "url": "/services/data/v58.0/chatter/comments/0D7...",
# "user": {
# "additionalLabel": null,
# "communityNickname": "User1696423780773910041",
# "companyName": "Salesforce",
# "displayName": "Name",
# "firstName": "Firstname",
# "id": "005...",
# "isActive": true,
# "isInThisCommunity": true,
# "lastName": "Name",
# "motif": {
# "color": "1B96FF",
# "largeIconUrl": "/img/icon/profile64.png",
# "mediumIconUrl": "/img/icon/profile32.png",
# "smallIconUrl": "/img/icon/profile16.png",
# "svgIconUrl": null
# },
# "mySubscription": null,
# "name": "Name",
# "outOfOffice": {
# "message": ""
# },
# "photo": {
# "fullEmailPhotoUrl": "https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1",
# "largePhotoUrl": "https://<my_domain>/profilephoto/7292o000000oAgZ/F",
# "mediumPhotoUrl": "https://<my_domain>/profilephoto/7292o000000oAgZ/M",
# "photoVersionId": "729...",
# "smallPhotoUrl": "https://<my_domain>/profilephoto/7292o000000oAgZ/T",
# "standardEmailPhotoUrl": "https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1",
# "url": "/services/data/v58.0/connect/user-profiles/005.../photo"
# },
# "reputation": null,
# "title": null,
# "type": "User",
# "url": "/services/data/v58.0/chatter/users/005...",
# "userType": "Internal"
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
IsRichText = jResp.BoolOf("body.isRichText")
Text = jResp.stringOf("body.text")
IsEditRestricted = jResp.BoolOf("capabilities.edit.isEditRestricted")
IsEditableByMeUrl = jResp.stringOf("capabilities.edit.isEditableByMeUrl")
AdditionalLabel = jResp.stringOf("capabilities.edit.lastEditedBy.additionalLabel")
CommunityNickname = jResp.stringOf("capabilities.edit.lastEditedBy.communityNickname")
CompanyName = jResp.stringOf("capabilities.edit.lastEditedBy.companyName")
DisplayName = jResp.stringOf("capabilities.edit.lastEditedBy.displayName")
FirstName = jResp.stringOf("capabilities.edit.lastEditedBy.firstName")
Id = jResp.stringOf("capabilities.edit.lastEditedBy.id")
IsActive = jResp.BoolOf("capabilities.edit.lastEditedBy.isActive")
IsInThisCommunity = jResp.BoolOf("capabilities.edit.lastEditedBy.isInThisCommunity")
LastName = jResp.stringOf("capabilities.edit.lastEditedBy.lastName")
Color = jResp.stringOf("capabilities.edit.lastEditedBy.motif.color")
LargeIconUrl = jResp.stringOf("capabilities.edit.lastEditedBy.motif.largeIconUrl")
MediumIconUrl = jResp.stringOf("capabilities.edit.lastEditedBy.motif.mediumIconUrl")
SmallIconUrl = jResp.stringOf("capabilities.edit.lastEditedBy.motif.smallIconUrl")
SvgIconUrl = jResp.stringOf("capabilities.edit.lastEditedBy.motif.svgIconUrl")
MySubscription = jResp.stringOf("capabilities.edit.lastEditedBy.mySubscription")
Name = jResp.stringOf("capabilities.edit.lastEditedBy.name")
Message = jResp.stringOf("capabilities.edit.lastEditedBy.outOfOffice.message")
FullEmailPhotoUrl = jResp.stringOf("capabilities.edit.lastEditedBy.photo.fullEmailPhotoUrl")
LargePhotoUrl = jResp.stringOf("capabilities.edit.lastEditedBy.photo.largePhotoUrl")
MediumPhotoUrl = jResp.stringOf("capabilities.edit.lastEditedBy.photo.mediumPhotoUrl")
PhotoVersionId = jResp.stringOf("capabilities.edit.lastEditedBy.photo.photoVersionId")
SmallPhotoUrl = jResp.stringOf("capabilities.edit.lastEditedBy.photo.smallPhotoUrl")
StandardEmailPhotoUrl = jResp.stringOf("capabilities.edit.lastEditedBy.photo.standardEmailPhotoUrl")
v_Url = jResp.stringOf("capabilities.edit.lastEditedBy.photo.url")
Reputation = jResp.stringOf("capabilities.edit.lastEditedBy.reputation")
Title = jResp.stringOf("capabilities.edit.lastEditedBy.title")
v_Type = jResp.stringOf("capabilities.edit.lastEditedBy.type")
LastEditedByUrl = jResp.stringOf("capabilities.edit.lastEditedBy.url")
UserType = jResp.stringOf("capabilities.edit.lastEditedBy.userType")
LastEditedDate = jResp.stringOf("capabilities.edit.lastEditedDate")
LatestRevision = jResp.IntOf("capabilities.edit.latestRevision")
RelativeLastEditedDate = jResp.stringOf("capabilities.edit.relativeLastEditedDate")
FeedEntityStatus = jResp.stringOf("capabilities.status.feedEntityStatus")
IsApprovableByMe = jResp.BoolOf("capabilities.status.isApprovableByMe")
DownVoteCount = jResp.IntOf("capabilities.upDownVote.downVoteCount")
MyVote = jResp.stringOf("capabilities.upDownVote.myVote")
UpVoteCount = jResp.IntOf("capabilities.upDownVote.upVoteCount")
IsVerifiableByMe = jResp.BoolOf("capabilities.verified.isVerifiableByMe")
IsVerified = jResp.BoolOf("capabilities.verified.isVerified")
IsVerifiedByAnonymized = jResp.stringOf("capabilities.verified.isVerifiedByAnonymized")
LastVerifiedByUser = jResp.stringOf("capabilities.verified.lastVerifiedByUser")
LastVerifiedDate = jResp.stringOf("capabilities.verified.lastVerifiedDate")
clientInfo = jResp.stringOf("clientInfo")
createdDate = jResp.stringOf("createdDate")
feedElementId = jResp.stringOf("feedElement.id")
feedElementUrl = jResp.stringOf("feedElement.url")
id = jResp.stringOf("id")
isDeleteRestricted = jResp.BoolOf("isDeleteRestricted")
CurrentPageToken = jResp.stringOf("likes.currentPageToken")
CurrentPageUrl = jResp.stringOf("likes.currentPageUrl")
NextPageToken = jResp.stringOf("likes.nextPageToken")
NextPageUrl = jResp.stringOf("likes.nextPageUrl")
PreviousPageToken = jResp.stringOf("likes.previousPageToken")
PreviousPageUrl = jResp.stringOf("likes.previousPageUrl")
Total = jResp.IntOf("likes.total")
likesMessage = jResp.stringOf("likesMessage")
moderationFlags = jResp.stringOf("moderationFlags")
myLike = jResp.stringOf("myLike")
parentId = jResp.stringOf("parent.id")
parentUrl = jResp.stringOf("parent.url")
relativeCreatedDate = jResp.stringOf("relativeCreatedDate")
threadLevel = jResp.IntOf("threadLevel")
threadParentId = jResp.stringOf("threadParentId")
v_type = jResp.stringOf("type")
url = jResp.stringOf("url")
userAdditionalLabel = jResp.stringOf("user.additionalLabel")
userCommunityNickname = jResp.stringOf("user.communityNickname")
userCompanyName = jResp.stringOf("user.companyName")
userDisplayName = jResp.stringOf("user.displayName")
userFirstName = jResp.stringOf("user.firstName")
userId = jResp.stringOf("user.id")
userIsActive = jResp.BoolOf("user.isActive")
userIsInThisCommunity = jResp.BoolOf("user.isInThisCommunity")
userLastName = jResp.stringOf("user.lastName")
MotifColor = jResp.stringOf("user.motif.color")
MotifLargeIconUrl = jResp.stringOf("user.motif.largeIconUrl")
MotifMediumIconUrl = jResp.stringOf("user.motif.mediumIconUrl")
MotifSmallIconUrl = jResp.stringOf("user.motif.smallIconUrl")
MotifSvgIconUrl = jResp.stringOf("user.motif.svgIconUrl")
userMySubscription = jResp.stringOf("user.mySubscription")
userName = jResp.stringOf("user.name")
OutOfOfficeMessage = jResp.stringOf("user.outOfOffice.message")
PhotoFullEmailPhotoUrl = jResp.stringOf("user.photo.fullEmailPhotoUrl")
PhotoLargePhotoUrl = jResp.stringOf("user.photo.largePhotoUrl")
PhotoMediumPhotoUrl = jResp.stringOf("user.photo.mediumPhotoUrl")
PhotoPhotoVersionId = jResp.stringOf("user.photo.photoVersionId")
PhotoSmallPhotoUrl = jResp.stringOf("user.photo.smallPhotoUrl")
PhotoStandardEmailPhotoUrl = jResp.stringOf("user.photo.standardEmailPhotoUrl")
PhotoUrl = jResp.stringOf("user.photo.url")
userReputation = jResp.stringOf("user.reputation")
userTitle = jResp.stringOf("user.title")
userType = jResp.stringOf("user.type")
userUrl = jResp.stringOf("user.url")
userUserType = jResp.stringOf("user.userType")
i = 0
count_i = jResp.SizeOfArray("body.messageSegments")
while i < count_i
jResp.put_I(i)
text = jResp.stringOf("body.messageSegments[i].text")
v_type = jResp.stringOf("body.messageSegments[i].type")
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("likes.items")
while i < count_i
jResp.put_I(i)
i = i + 1
end
Curl Command
curl -X PATCH
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"body": {
"messageSegments": [
{
"type": "Text",
"text": "Editing a comment"
}
]
}
}'
https://domain.com/services/data/v{{version}}/chatter/comments/:COMMENT_ID
Postman Collection Item JSON
{
"name": "Comment - Edit",
"protocolProfileBehavior": {
"disabledSystemHeaders": {}
},
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"body\": {\n \"messageSegments\": [\n {\n \"type\": \"Text\",\n \"text\": \"Editing a comment\"\n }\n ]\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/chatter/comments/:COMMENT_ID",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"chatter",
"comments",
":COMMENT_ID"
],
"variable": [
{
"key": "COMMENT_ID",
"value": "0D7..."
}
]
},
"description": "Get information about, edit, or delete a comment.\nTo post a comment, use Feed Elements Capability, Comments Items.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_comments_specific.htm#connect_resources_comments_specific"
},
"response": [
{
"name": "Successful Comment - Edit",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"body\": {\n \"messageSegments\": [\n {\n \"type\": \"Text\",\n \"text\": \"Editing a comment\"\n }\n ]\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/chatter/comments/:COMMENT_ID",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"chatter",
"comments",
":COMMENT_ID"
],
"variable": [
{
"key": "COMMENT_ID",
"value": "0D7..."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 22 Nov 2023 11:22:36 GMT"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000; includeSubDomains"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "X-Robots-Tag",
"value": "none"
},
{
"key": "Cache-Control",
"value": "no-cache,must-revalidate,max-age=0,no-store,private"
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "{\n \"body\": {\n \"isRichText\": false,\n \"messageSegments\": [\n {\n \"text\": \"Editing a comment\",\n \"type\": \"Text\"\n }\n ],\n \"text\": \"Editing a comment\"\n },\n \"capabilities\": {\n \"edit\": {\n \"isEditRestricted\": false,\n \"isEditableByMeUrl\": \"/services/data/v58.0/chatter/comments/0D7.../capabilities/edit/is-editable-by-me\",\n \"lastEditedBy\": {\n \"additionalLabel\": null,\n \"communityNickname\": \"User1696423780773910041\",\n \"companyName\": \"Salesforce\",\n \"displayName\": \"Name\",\n \"firstName\": \"Firstname\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"Name\",\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"Name\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1\",\n \"largePhotoUrl\": \"https://<my_domain>/profilephoto/7292o000000oAgZ/F\",\n \"mediumPhotoUrl\": \"https://<my_domain>/profilephoto/7292o000000oAgZ/M\",\n \"photoVersionId\": \"729...\",\n \"smallPhotoUrl\": \"https://<my_domain>/profilephoto/7292o000000oAgZ/T\",\n \"standardEmailPhotoUrl\": \"https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n },\n \"reputation\": null,\n \"title\": null,\n \"type\": \"User\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\",\n \"userType\": \"Internal\"\n },\n \"lastEditedDate\": \"2023-11-22T11:22:36.000Z\",\n \"latestRevision\": 2,\n \"relativeLastEditedDate\": \"Just now\"\n },\n \"status\": {\n \"feedEntityStatus\": \"Published\",\n \"isApprovableByMe\": true\n },\n \"upDownVote\": {\n \"downVoteCount\": 0,\n \"myVote\": \"None\",\n \"upVoteCount\": 0\n },\n \"verified\": {\n \"isVerifiableByMe\": false,\n \"isVerified\": false,\n \"isVerifiedByAnonymized\": null,\n \"lastVerifiedByUser\": null,\n \"lastVerifiedDate\": null\n }\n },\n \"clientInfo\": null,\n \"createdDate\": \"2023-11-22T11:19:50.000Z\",\n \"feedElement\": {\n \"id\": \"0D5...\",\n \"url\": \"/services/data/v58.0/chatter/feed-elements/0D5...\"\n },\n \"id\": \"0D7...\",\n \"isDeleteRestricted\": false,\n \"likes\": {\n \"currentPageToken\": null,\n \"currentPageUrl\": \"/services/data/v58.0/chatter/comments/0D7.../likes\",\n \"items\": [],\n \"nextPageToken\": null,\n \"nextPageUrl\": null,\n \"previousPageToken\": null,\n \"previousPageUrl\": null,\n \"total\": 0\n },\n \"likesMessage\": null,\n \"moderationFlags\": null,\n \"myLike\": null,\n \"parent\": {\n \"id\": \"005...\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\"\n },\n \"relativeCreatedDate\": \"2m ago\",\n \"threadLevel\": 0,\n \"threadParentId\": null,\n \"type\": \"TextComment\",\n \"url\": \"/services/data/v58.0/chatter/comments/0D7...\",\n \"user\": {\n \"additionalLabel\": null,\n \"communityNickname\": \"User1696423780773910041\",\n \"companyName\": \"Salesforce\",\n \"displayName\": \"Name\",\n \"firstName\": \"Firstname\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"Name\",\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"Name\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1\",\n \"largePhotoUrl\": \"https://<my_domain>/profilephoto/7292o000000oAgZ/F\",\n \"mediumPhotoUrl\": \"https://<my_domain>/profilephoto/7292o000000oAgZ/M\",\n \"photoVersionId\": \"729...\",\n \"smallPhotoUrl\": \"https://<my_domain>/profilephoto/7292o000000oAgZ/T\",\n \"standardEmailPhotoUrl\": \"https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n },\n \"reputation\": null,\n \"title\": null,\n \"type\": \"User\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\",\n \"userType\": \"Internal\"\n }\n}"
}
]
}
