Homepage Get started Platform Support

Create event

This request is used to create a new event inside your organisation.

POST https://api.eventgoose.com/v1/events

Authentication

Authenticate yourself using your organisation api token

Parameters

name
string
required

The name of the event.
description
longtext
optional

The description for the event.
is_online
boolean
required

Determine if your event has a physical location or not.

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

The venue for the event.

Note

This field is required if the is_online field is set to 0

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
required

The city of the venue.

Note

This field is required if the is_online field is set to 0

zipcode
string
optional

The zipcode of the venue.
country
string
required

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

type
string
required

Determine the type of the event.

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

When and at what time will the event take place.

Note

This field is required unless the type field is set to continuous

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
optional

An image that will be displayed inside the shop.

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

A video will be displayed inside the shop.

For now only YouTube links are supported.
extra_info
object
optional

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

title
string
optional

The title of the extra info object.
description
longtext
optional

The description of the extra info object.
service_fee
number
optional

Set up a service fee for the event.
legal
object
optional

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

privacy_statement_id
integer
optional

Add a privacy statement to the event.

Available privacy statements can be retrieved via the List privacy statements resource.
terms_and_condition_id
integer
optional

Add terms and conditions to the event.

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

Setup billing information for the event.

Available billing information can be retrieved via the List billing information resource.
mail_moments
array
optional

Setup one or multiple reminder mails for the event.

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
        }
    ]
}