Homepage Get started Platform Support

Update event

This request is used to update the event by its identifier.

POST https://api.eventgoose.com/v1/events/{id}

Authentication

Authenticate yourself using your organisation api token

Parameters

Note

Unlike the Create event resource most of the parameters in this resource will be optional. This ensures that individual elements can be updated without including all the parameters over and over.

name
string
optional

The name of the event.
description
longtext|null
optional

The description for the event.

Set the value to null to remove the current description.
is_online
boolean
optional

Determine if the event has a physical location or not.

If your event does have a physical location, the venue[city] and venue[country_id] and fields will be required.
venue
object
optional

The venue for the event.

Note

This field is required if the is_online field is set to 0 and you don't have yet added a venue

name
string
optional

The name of the venue.
street
string
optional

The street of the venue.
house_number
string
optional

The house number of the venue.
city
string
optional

The city of the venue.

Note

This field is required if the is_online field is set to 0 and you don't have yet added a venue

zipcode
string
optional

The zipcode of the venue.
country_id
integer
optional

The country of the venue in the following format 2-lettering ISO 3166-1

For example: NL

Note

This field is required if the is_online field is set to 0 and you don't have yet added a venue

type
string
optional

Determine the type of the event.

Must be one of the following values: single-day multiple-days continuous
dates
array|null
optional

When and at what time will the event take place.

This will replace the current dates. If you want to delete the current dates, set the value to null

date
date
required

The date in the following format YYYY-MM-DD
start_time
date
required

The start time in the following format HH:mm
end_time
date
required

The end time in the following format HH:mm
max_capacity
integer
optional

Set a daily max capacity for the event.

Note

This field is required if the type field is set to continuous. For all other types the max capacity will be set at ticket level.

header_image
file|null
optional

An image that will be displayed inside the shop.

Desired dimensions are 1140 x 400px and the max file size is 5mb

Set the value to null to remove the current header image.
header_video
string|null
optional

A video will be displayed inside the shop.

For now only YouTube links are supported.

Set the value to null to remove the current header video.
extra_info
object|null
optional

An additional way to provide the shop with information about your event.

Set the value to null to remove the current extra info.

title
string|null
optional

The title of the extra info object.

Set the value to null to remove the current title.
description
longtext|null
optional

The description of the extra info object.

Set the value to null to remove the current description.
service_fee
number|null
optional

Set up a service fee for the event.

Set the value to null to remove the current service fee.
legal
object
optional

This object contains al the legal documents and information for your event.

privacy_statement_id
integer|null
optional

Add a privacy statement to the event.

Available privacy statements can be retrieved via the List privacy statements resource.

Set the value to null to remove the current privacy statement.
terms_and_condition_id
integer|null
optional

Add terms and conditions to the event.

Available terms and conditions can be retrieved via the List terms and conditions resource.

Set the value to null to remove the current terms and conditions.
billing_information_id
integer|null
optional

Setup billing information for the event.

Available billing information can be retrieved via the List billing information resource.

Set the value to null to remove the current billing information.
mail_moments
array|null
optional

Setup one or multiple reminder mails for the event

This will replace the current mail moments. If you want to delete the current mail moments, set the value to null

moment
date
required

The datetime of the mail moment in the following format ISO 8601

For example: 2021-07-05T10:00:00.000Z
subject
string
optional

The subject of the mail moment.

Response

200 application/json

    HTTP/1.1 200 OK
Content-Type: application/json
    
{
    "id": "jL3DYVM4ApEBJn4w",
    "name": "Golden Plains",
    "is_continuous": false,
    "dates": [
        {
            "id": "5dP8kGOmLlEwgmlr",
            "starts_at": "2020-12-18T17:00:00.000000Z",
            "ends_at": "2020-12-18T22:30:00.000000Z"
        },
        {
            "id": "oLenyp2qbDMRAQVY",
            "starts_at": "2020-12-19T17:00:00.000000Z",
            "ends_at": "2020-12-19T22:30:00.000000Z"
        }
    ],
    "venue": {
        "name": "Eventgoose: Online Tickets Verkopen",
        "street": "F.B. Deurvorststraat",
        "house_number": "43",
        "addition": null,
        "zipcode": "7071 BG",
        "city": "Ulft",
        "state": null,
        "country": "Netherlands"
    },
    "shops": [
        "a5KgQw2vqOPlAZJ9",
        "3Q4aZe21jMrlkY6x"
    ],
    "tickets": [
        {
            "id": "3Q4aZe21N0MrlkY6",
            "name": "Regular",
            "price": "50.00",
            "service_fee": 1,
            "min_order_amount": 0,
            "max_order_amount": 10,
            "sold_out": true
        },
        {
            "id": "0nqJjGEj3WOedYPQ",
            "name": "VIP",
            "price": "75.00",
            "service_fee": 1,
            "min_order_amount": 0,
            "max_order_amount": 10,
            "sold_out": true
        }
    ]
}