Api Documentation

Comments

Comments allow your users to give feedback to news articles or bulletinboard items. Users can leave comments on news articles or bulletinboard items. They can also edit their own comments. User authentication is required for the CREATE and UPDATE methods.
listWithout user authenticationWith user authenticationchevron_right
Retrieve all comments.
singleWithout user authenticationWith user authenticationchevron_right
Retrieve a single comment.
createWith user authenticationchevron_right
Place a comment with the currently logged in user.
updateWith user authenticationchevron_right
Edit a comment placed by the currently logged in user.
deleteWithout user authenticationWith user authenticationchevron_right
Deletes a single comment.
Json
XML
POST https://api.bundeling.com/V2/comments

Parameters

Body

NameDescriptionTypeNillableRequired
object_uuidA unique identifier used to identify the object to place the comment onstringfalsetrue
commentThe message you wish to comment on the object.stringfalsetrue
object_typeType of the object
Accepted values: news_item, bulletin_board_items
stringfalsefalse
parent_uuidthe uuid of the comment this is a reply tostringfalsefalse
external_referenceReference for linking to external systems.stringfalsefalse

Example request

Headers

Content-Type:application/json
Api-Key:RAegSX8yZfEbqSPM

Body

{
    "object_uuid": "oftihj5oij23okhjoioftj5os3",
    "comment": "This is a comment.",
    "object_type": "news_item",
    "parent_uuid": "oftihj5oij23okhjoioftj5os3",
    "external_reference": "123908"
}

Example response

{
    "uuid": "podj65hoij23r09thoji5",
    "author_uuid": "eokgieu5hjgieu5ghjr4",
    "comment": "This is a comment.",
    "object_type": "news_item",
    "external_reference": "123908",
    "creationdate": "2024-01-20T00:00:00+0100",
    "lastupdate": "2024-01-20T00:00:00+0100"
}