MessageReplies REST API endpoint
Disclaimer: This endpoint documentation is generated from the latest Sitevision version. It might differ from the actual Sitevision environment where your website resides.
Use the RestApi utility of the Public API for server-side access of this endpoint.
MessageReplies
Get, create, update or delete message replies (đ§”).
Applicable to: sv:topicTimelineEntry and sv:timelineEntry of a sv:directMessageConversation.
GET
Returns a collection of replies from a message in a sv:topic (channel) or a sv:directMessageConversation
Requirements
- The feature "social collaboration" and that social collaboration is enabled on the sv:site.
- The caller must have a sv:userIdentity.
Permissions
- Retrieving replies from a message in a private sv:topic requires that the caller is a member of the sv:topic.
- Retrieving replies from a message in a sv:directMessageConversation requires that the caller is a member of the sv:directMessageConversation.
Parameters
| Name | Type | Default | Values | Description |
|---|---|---|---|---|
| skip | number |
0 | Any positive value | Skips leading number of replies. |
| limit | number |
10 | 1 - 500 | Limits the number of replies to return. |
| offsetCommentId | string |
404.xxx | From which point to retrieve following replies. | |
| order | string |
REVERSE_CHRONOLOGICAL | CHRONOLOGICAL, REVERSE_CHRONOLOGICAL | Determines sort order of the replies. CHRONOLOGICAL returns oldest first. REVERSE_CHRONOLOGICAL returns newest first. |
| messageFormat | string |
JSON | HTML, PLAIN, JSON, JSON_TREE, MARKDOWN |
The data format for the message in the returned result (MARKDOWN since 2024.11.1).
Legacy note! MARKDOWN is not applicable for comments stored in the legacy format used prior to 2025.01.1! Using MARKDOWN for such entries will result in the message being returned in HTML format instead. |
Example URL
439.26084f3118dd04577272/messagereplies
Example response
[
{
"message": [
{
"type": "text",
"text": "I totally agree"
}
],
"id": "404.2f46d81518dd5461276123",
"creationDate": 1708691883679,
"author": {
"id": "400.3b7a4d2c18a403d8f70a",
"fullName": "Jane Doe",
"disabled": false,
"BuddyIconSize_SMALL": "/svplaceholder/32/400.3b7a4d2c18a403d8f70a.webp",
"BuddyIconSize_LARGE": "/svplaceholder/48/400.3b7a4d2c18a403d8f70a.webp",
"BuddyIconSize_X_LARGE": "/svplaceholder/64/400.3b7a4d2c18a403d8f70a.webp"
},
"isModified": false,
"reactions": []
},
{
"message": [
{
"type": "text",
"text": "Good idea!"
}
],
"id": "404.2f46d81518dd5461276121",
"creationDate": 1708691613456,
"author": {
"id": "400.c9230718a03a4dee41",
"fullName": "John Doe",
"disabled": false,
"BuddyIconSize_SMALL": "/images/200.11e3482d18a4f98c8df31/1693553706231/john.webp",
"BuddyIconSize_LARGE": "/images/200.11e3482d18a4f98c8df32/1693553706282/john.webp",
"BuddyIconSize_X_LARGE": "/images/200.11e3482d18a4f98c8df30/1693553705992/john.webp"
},
"isModified": true,
"modifiedAt": 1708691730784,
"reactions": []
}
]
POST
Reply to a message in a sv:topic or sv:directMessageConversation.
Returns an object containing the newly created reply.
Requirements
- The feature "social collaboration" and that social collaboration is enabled on the sv:site.
- The caller must have a sv:userIdentity.
- When replying to a message in a sv:topic, the sv:topic must not be archived.
Permissions
- Requires that the calling sv:userIdentity is a member of the sv:topic or the sv:directMessageConversation where the message exists.
Parameters
| Name | Type | Default | Values | Description |
|---|---|---|---|---|
| message | string |
The message of the entry (plain text or Markdown-formatted plain text).
The max length of the message is determined by the social collaboration max character count setting (maxEntryCharacterCount property of the sv:site). |
||
| messageFormat | string |
JSON | HTML, PLAIN, JSON, JSON_TREE, MARKDOWN | The data format for the message in the returned result (MARKDOWN since 2024.11.1). |
Example URL
439.26084f3118dd04577272/messagereplies
Example input
{
"message": "Wow đź"
}
Example response
{
"message": [
{
"type": "text",
"text": "Wow đź"
}
],
"id": "404.2f46d81518dd5461276125",
"creationDate": 1708693719758,
"author": {
"id": "400.c9230718a03a4dee41",
"fullName": "John Doe",
"disabled": false,
"BuddyIconSize_SMALL": "/images/200.11e3482d18a4f98c8df31/1693553706231/john.webp",
"BuddyIconSize_LARGE": "/images/200.11e3482d18a4f98c8df32/1693553706282/john.webp",
"BuddyIconSize_X_LARGE": "/images/200.11e3482d18a4f98c8df30/1693553705992/john.webp"
},
"isModified": false
}
PUT
Update a reply.
Returns an object containing the updated reply.
Requirements
- The feature "social collaboration" and that social collaboration is enabled on the sv:site.
- The caller must have a sv:userIdentity.
- The targeted reply must belong to the targeted message.
- When updating a reply in a sv:topic, the sv:topic must not be archived.
Permissions
- Requires that the calling sv:userIdentity is the author of the reply and member of the sv:topic or sv:directMessageConversation where the reply exists.
Parameters
| Name | Type | Default | Values | Description |
|---|---|---|---|---|
| message | string |
The new message of the entry (plain text or Markdown-formatted plain text).
The max length of the message is determined by the social collaboration max character count setting (maxEntryCharacterCount property of the sv:site). |
||
| messageFormat | string |
JSON | HTML, PLAIN, JSON, JSON_TREE, MARKDOWN | The data format for the message in the returned result (MARKDOWN since 2024.11.1). |
Example URL
439.26084f3118dd04577272/messagereplies/404.2f46d81518dd5461276125
Example input
{
"message": "Hello!"
}
Example response
{
"message": [
{
"type": "text",
"text": "Hello!"
}
],
"id": "404.2f46d81518dd5461276125",
"author": {
"id": "400.c9230718a03a4dee41"
},
"isModified": true,
"modifiedAt": 1708694621317
}
DELETE
Delete a reply.
Returns an object containing status.
Requirements
- The feature "social collaboration" and that social collaboration is enabled on the sv:site.
- The caller must have a sv:userIdentity.
- The targeted reply must belong to the targeted message.
- When deleting a reply in a sv:topic, the sv:topic must not be archived.
Permissions
- Requires that the calling sv:userIdentity is the author of the reply and member of the sv:topic or sv:directMessageConversation where the reply exists.
Example URL
439.26084f3118dd04577272/messagereplies/404.2f46d81518dd5461276125
Example response
{
"success": true
}