Api Documentation

Matches

Matches can be sponsored by Customers through the sponsor_customers field. The players field contains an array of player uuid's. To turn these uuid's into names, use the PLAYERS endpoint. When the Man of the Match module is enabled, users can vote for their Man of the Match through the MANOFTHEMATCH endpoint.
listWithout user authenticationWith user authenticationchevron_right
Retrieves a collection of matches.
singleWithout user authenticationWith user authenticationchevron_right
Retrieves single match.
createWithout user authenticationchevron_right
Creates a new match. Only available to API keys without user authentication.
updateWithout user authenticationchevron_right
Creates a new match. Only available to API keys without user authentication.
deleteWithout user authenticationchevron_right
Deletes a single match. Only available to API keys without user authentication.
Json
XML
POST https://api.bundeling.com/V2/matches

Parameters

Body

NameDescriptionTypeNillableRequired
opponent_club_uuidThe unique identifier of the club your team will be playing against.stringfalsetrue
home_matchDefines if the match is played at home or away.booleanfalsetrue
extra_tickets_enabledDefine if the "Extra Tickets" option should be enabled.booleanfalsefalse
locationThe location where the match will be played.stringfalsetrue
attending_emailWhen users set their status to "attending" a confirmation email will be sent to this address.stringfalsefalse
attendance_enabledSetting this to true will allow users to attend the event.booleanfalsefalse
attendance_advancedSetting this to true will allow advanced register for the event.booleanfalsefalse
attendance_guestsSetting this to true will allow users to bring guests to the event.booleanfalsefalse
attendance_notesSetting this to true will allow users to write notes.booleanfalsefalse
dateThe date and time of the match.datetimefalsetrue
sponsor_customersCustomers can sponsor matches, set this field to the ids of the sponsoring customers.jsonfalsefalse
publicationdateThe date on which this match will be available to users.datetimefalsetrue
attendance_form_uuidA unique identifier used to identify the attendace form of the event.stringfalsefalse
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 matchmixedfalsefalse

Actions

NameDescriptionResettable
pushbroadcast_1_1Send push notification on notification datetrue
pushbroadcast_home_match_1(Home match) Send Man of the Match reminder push notification to all app userstrue

Example request

Headers

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

Body

{
    "opponent_club_uuid": "d7743aaf53224e279853c7d0c1dbfb3a",
    "home_match": true,
    "extra_tickets_enabled": true,
    "location": "Uden",
    "attending_email": "support@bundeling.com",
    "attendance_enabled": "true",
    "attendance_advanced": "false",
    "attendance_guests": "true",
    "attendance_notes": "true",
    "date": "2017-02-10T16:00:00+0000",
    "sponsor_customers": [
        "603222387277473c997e1b0f92f45001",
        "603222387277473c997e1b0f92f45002"
    ],
    "publicationdate": "2017-01-15T18:00:00+0000",
    "attendance_form_uuid": "d669b048d2084892b5a5232b78923227",
    "external_reference": "123908",
    "labels": [
        "eeb763c41c054dcc8f6d9362f24ee9b2"
    ],
    "actions": {
        "pushbroadcast_1_1": {
            "enabled": true
        }
    }
}

Example response

{
    "uuid": "eeb763c41c054dcc8f6d9362f24ee9b2",
    "opponent_club_uuid": "d7743aaf53224e279853c7d0c1dbfb3a",
    "home_match": true,
    "goals_self": 2,
    "goals_opponent": 0,
    "location": "Uden",
    "attending_email": "support@bundeling.com",
    "man_of_the_match_uuid": "8e09c4749b234633a7319148aac8cb81",
    "attendance_enabled": true,
    "attendance_advanced": true,
    "attendance_guests": true,
    "attendance_notes": true,
    "date": "2024-05-21T12:00:00+0200",
    "sponsor_customers": [
        "603222387277473c997e1b0f92f45001",
        "603222387277473c997e1b0f92f45002"
    ],
    "publicationdate": "2024-05-13T12:00:00+0200",
    "actions": {
        "pushbroadcast_1_1": {
            "enabled": true,
            "executed": false
        },
        "pushbroadcast_home_match_1": {
            "enabled": true,
            "executed": false
        }
    },
    "players": [
        "603222387277473c997e1b0f92f45001",
        "603222387277473c997e1b0f92f45002",
        "603222387277473c997e1b0f92f45003",
        "603222387277473c997e1b0f92f45004"
    ],
    "attendance_form_uuid": "d669b048d2084892b5a5232b78923227",
    "attending_users": [
        "48b99d307f8746a8b126f76be5d1153e",
        "603222387277473c997e1b0f92f45076"
    ],
    "visitor_count": 450,
    "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"
}