Api Documentation

Polls

Polls on which users can vote
listWithout user authenticationWith user authenticationchevron_right
Retrieves a collection of polls.
singleWithout user authenticationWith user authenticationchevron_right
Retrieves a single poll.
createWithout user authenticationchevron_right
Creates a new poll. Only available to API keys without user authentication. When an image tag is included in the text 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 poll. Only available to API keys without user authentication.
deleteWithout user authenticationchevron_right
Deletes a single poll. Only available to API keys without user authentication.
Json
XML
PUT https://api.bundeling.com/V2/polls

Parameters

Url

NameDescriptionType
uuidA unique identifier used to identify a pollstring

Body

NameDescriptionTypeNillable
author_uuidThe unique identifier of the user of the authorstringfalse
titleThe title of the pollstringfalse
textThe body of the poll.stringfalse
startdateThe date on which this poll will start.datetimefalse
enddateThe date on which this poll will end.datetimefalse
external_referenceReference for linking to external systems.stringfalse
actionsTimed events that can be triggered for this pollmixedfalse

Actions

NameDescriptionResettable
pushbroadcast_1_1Push notification on start datetrue
pushnotification_1_1Reminder notification to all users who have not voted yettrue

Example request

Headers

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

Body

{
    "author_uuid": "d7743aaf53224e279853c7d0c1dbfb3a",
    "title": "Your vote counts",
    "text": "Make your choice and vote for one of these options...",
    "startdate": "2017-01-15T18:00:00+0000",
    "enddate": "2017-01-16T10:00:00+0000",
    "external_reference": "123908",
    "actions": {
        "pushbroadcast_1_1": {
            "enabled": true
        }
    }
}

Example response

{
    "uuid": "eeb763c41c054dcc8f6d9362f24ee9b2",
    "author_uuid": "d7743aaf53224e279853c7d0c1dbfb3a",
    "headerimage": "eyJjbGllbnQiOjEwLCJwYXRoIjoiYnVsbGV0aW5fYm9hcmRfcGljdHVyZXNcLz...",
    "title": "Your vote counts",
    "text": "Make your choice and vote for one of these options...",
    "options": [
        {
            "uuid": "ac3b84bb591141778d81b553d2d05e9c",
            "text": "Choice 1"
        },
        {
            "uuid": "55895aceb9084dbf933301f0add9e2d6",
            "text": "Choice 2"
        }
    ],
    "actions": {
        "pushbroadcast_1_1": {
            "enabled": true,
            "executed": false
        },
        "pushnotification_1_1": {
            "enabled": true,
            "executed": false
        }
    },
    "labels": [
        "d7743aaf53224e279853c7d0c1dbfb3a",
        "d7743aaf53224e279853c7d0c1dbfb3a"
    ],
    "combined_labels": {
        "uuid": "d7743aaf53224e279853c7d0c1dbfb3a",
        "labels": [
            "d7743aaf53224e279853c7d0c1dbfb3a",
            "d7743aaf53224e279853c7d0c1dbfb3a"
        ]
    },
    "startdate": "2024-05-13T12:00:00+0200",
    "enddate": "2024-05-27T12:00:00+0200",
    "external_reference": "123908",
    "creationdate": "2024-01-20T00:00:00+0100",
    "lastupdate": "2024-01-20T00:00:00+0100"
}