PUT Comments
Update Comment
URL Arguments comment conversation id : required The ID of the comment conversation, URL ENCODED.
URL Arguments
- comment_conversation_id : (required) The ID of the comment conversation, URL ENCODED.
- comment_comment_id : (required) The unique ID of the comment, URL ENCODED.
BODY Properties
- userid : (required) The application specific user ID of the comment to be updated. This must be the owner of the comment or moderator / admin.
- body : (required) The new body contents of the comment.
The comment will be flagged to indicate that it has been modified.
Request
Parameters
Values in the path and query string.
appid path string TalkLabs ID required
The TalkLabs application ID assigned to your account.
Example:your-app-id conversationid path string TalkLabs ID required
The TalkLabs assigned conversation ID.
Example:conversation-id commentid path string TalkLabs ID required
The TalkLabs assigned comment ID.
Example:comment-id Request
JSON body
Send as application/json.
userId string customer-defined required
The customer defined user ID from your application or identity system.
body string required
added string · date-time
commentType integer · int32
customType string
customId string customer-defined
A customer defined ID chosen by your application. TalkLabs stores it so you can retrieve the resource without keeping its TalkLabs ID.
customPayload string
customField1 string
customField2 string
customTags string[]
handle string
displayName string
pictureUrl string
profileUrl string
role integer · int32
userCustomTags string[]
Request example
{
"body": "Comment has been modified",
"userId": "u-8842"
} Response
Status codes
Every JSON response uses the API result envelope.
200 OK ApiResult 400 Bad Request ApiResult 403 Forbidden ApiResult 404 Not Found ApiResult 500 Internal Server Error ApiResult Example response · 200
{
"message": "",
"errors": {},
"data": {
"kind": "comment.comment",
"id": "5e95afc238a2831340816195",
"appid": "5e9389ed38a2b10794e271ee",
"conversationid": "my_conversation_id",
"commenttype": "comment",
"added": 1586868162,
"modified": 1586868474,
"userid": "u-8842",
"user": {
"kind": "app.user",
"userid": "u-8842",
"handle": "dave_m",
"handlelowercase": "georgew",
"displayname": "Dave M.",
"pictureurl": "https://example.com/users/u-8842s/photos/original/a9/c7/a6/44-1-george-washington-18-1549729902.jpg",
"profileurl": "https://example.com/users/u-8842shington",
"banned": false
},
"body": "Comment has been modified",
"customtype": null,
"customid": null,
"custompayload": null,
"tags": [
"taga",
"tagb"
],
"edited": true,
"deleted": false,
"parentid": "",
"replyto": null,
"hierarchy": [],
"mentions": [],
"reactions": [
{
"type": "like",
"count": 1,
"users": [
{
"userid": "u-8842",
"handle": "dave_m",
"displayname": "Dave M."
}
]
}
],
"replycount": 0,
"votecount": 1,
"votescore": 1,
"votes": [
{
"type": "up",
"count": 1,
"users": [
{
"userid": "u-8842",
"handle": "dave_m",
"displayname": "Dave M."
}
]
}
],
"moderation": "na",
"active": true,
"reports": []
}
}