Api Documentation

News

News keeps your users up-to-date about current events surrounding your network.
listWithout user authenticationWith user authenticationchevron_right
Retrieves a collection of news.
singleWithout user authenticationWith user authenticationchevron_right
Retrieves a single newsitem.
createWithout user authenticationchevron_right
Creates a new newsitem. Only available to API keys without user authentication. When an image tag is included in the content field, these files are downloaded. They need to be publicly accessible. We support PNG and JPEG image file types.
updateWithout user authenticationchevron_right
Updates an existing newsitem. Only available to API keys without user authentication.
deleteWithout user authenticationchevron_right
Deletes a single newsitem. Only available to API keys without user authentication.
Json
XML
POST https://api.bundeling.com/V2/news

Parameters

Body

NameDescriptionTypeNillableRequired
author_uuidThe unique identifier of the authorstringtruefalse
titleThe title of the newsitemstringfalsetrue
contentThe body of the newsitem.stringfalsetrue
category_uuidThe unique identifier of the categorystringtruefalse
event_uuidTo link the item to an event by using the unique identifier.stringfalsefalse
sponsor_uuidTo create a sponsored newsitem please set a customer unique identifier in this field.stringfalsefalse
linkA link to an external website that will be appended to the newsitem.stringfalsefalse
social_sharingWhen set to true, users will be able to share this newsitem on social media.booleanfalsefalse
like_enabledWhen set to true, users will be able to like this newsitem.booleanfalsefalse
comments_enabledWhen set to true, users will be able to comment on this newsitem.booleanfalsefalse
draftSave the newsitem as draft or published.booleanfalsefalse
publicationdateThe date on which this newsitem will be available to users.datetimefalsetrue
external_referenceReference for linking to external systems.stringfalsefalse
labelsLabels to add to this newsitem.array(string)falsefalse
actionsTimed events that can be triggered for this newsitemmixedfalsefalse

Actions

NameDescriptionResettable
pushbroadcast_1_1News item push notification to all users on publication datetrue

Example request

Headers

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

Body

{
    "author_uuid": "d7743aaf53224e279853c7d0c1dbfb3a",
    "title": "Welcome to Bundeling",
    "content": "Bundeling would like to welcome...",
    "category_uuid": "8e09c4749b234633a7319148aac8cb81",
    "event_uuid": "d669b048d2084892b5a5232b78923227",
    "sponsor_uuid": "48b99d307f8746a8b126f76be5d1153e",
    "link": "www.ecom.nl",
    "social_sharing": true,
    "like_enabled": true,
    "comments_enabled": true,
    "draft": false,
    "publicationdate": "2024-04-20T00:00:00+0200",
    "external_reference": "123908",
    "labels": [
        "eeb763c41c054dcc8f6d9362f24ee9b2"
    ],
    "actions": {
        "pushbroadcast_1_1": {
            "enabled": true
        }
    }
}

Example response

{
    "uuid": "eeb763c41c054dcc8f6d9362f24ee9b2",
    "author_uuid": "d7743aaf53224e279853c7d0c1dbfb3a",
    "headerimage": "eyJjbGllbnQiOjEwLCJwYXRoIjoiYnVsbGV0aW5fYm9hcmRfcGljdHVyZXNcLz...",
    "title": "Welcome to Bundeling",
    "content": "Bundeling would like to welcome...",
    "language": "en",
    "category": "Technology",
    "category_uuid": "8e09c4749b234633a7319148aac8cb81",
    "event_uuid": "d669b048d2084892b5a5232b78923227",
    "sponsor_uuid": "48b99d307f8746a8b126f76be5d1153e",
    "link": "www.ecom.nl",
    "social_sharing": true,
    "draft": false,
    "actions": {
        "pushbroadcast_1_1": {
            "enabled": true,
            "executed": false
        }
    },
    "publicationdate": "2024-04-20T00:00:00+0200",
    "external_reference": "123908",
    "labels": [
        "d7743aaf53224e279853c7d0c1dbfb3a",
        "d7743aaf53224e279853c7d0c1dbfb3a"
    ],
    "combined_labels": {
        "uuid": "d7743aaf53224e279853c7d0c1dbfb3a",
        "labels": [
            "d7743aaf53224e279853c7d0c1dbfb3a",
            "d7743aaf53224e279853c7d0c1dbfb3a"
        ]
    },
    "creationdate": "2024-01-20T00:00:00+0100",
    "lastupdate": "2024-01-20T00:00:00+0100"
}