Homepage Get started Platform Support

Update ticket

This request is used to update a ticket inside your organisation.

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

Authentication

Authenticate yourself using your organisation api token

Parameters

Note

Unlike the Create ticket 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 your ticket.
event_id
integer|null
optional

The event where the ticket belongs to.

Set the value to null to remove the current event id.
dates
array|null
optional

An array on event date ids.

On these dates you ticket will be available to scan.

Set the value to null to remove the current dates.
price
decimal
optional

The price of your ticket.
max_capacity
integer|null
optional

Determine the capacity of your ticket.

If no max_capacity is set, there will be an unlimited stock of your ticket.

Set the value to null to remove the current max capacity.
min_order_amount
integer|null
optional

The minimum amount of tickets that can be ordered by a customer.

If no min_order_amount is set, the minimum will be 1.

Set the value to null to remove the current min order amount.
max_order_amount
integer|null
optional

The maximum amount of tickets that can be purchased by a customer.

If no min_order_amount is set, the maximum will be 99.

Set the value to null to remove the current max order amount.
template_id
integer|null
optional

Which A4 ticket template will be used when a ticket is purchased.

If no template_id is provided, the default template will be used.

Set the value to null to remove the current templated id.
mobile_template_id
integer|null
optional

Which mobile ticket template will be used when a ticket is purhcased.

If no mobile template id is provided, the default mobile template will be used.

Set the value to null to remove the current mobile template id.
availability
array|null
optional

Determine when your ticket will be available in a shop.

Set the value to null to remove the current availability.

opens_at
date
required

A datetime in the following format ISO 8601
closes_at
string
required

A datetime in the following format ISO 8601
related_tickets
array|null
optional

An array of ticket ids that are related to this ticket. These related tickets will be recommended to the customer when buying the ticket.

Set the value to null to remove the current related tickets.
excluded_tickets
array
optional

An array of ticket ids that are excluded from buying when this ticket is inside the customers cart.

Set the value to null to remove the current excluded tickets.
on_fire
boolean
optional

Stimulate your sales by setting the ticket "on fire" to show that it is a populair product.
sales_percentage
object
optional

Increase the conversion on a ticket by showing the sales percentage (95% sold out).

active
boolean
optional

Activate or deactivate this feature.
percentage
integer
optional

The percentage to what extent the ticket has already been "sold".
is_hidden
boolean
optional

Temporarily hide your ticket from all shops.
is_entry
boolean
optional

Determine if a ticket is an entry ticket.

Response

200 application/json

    HTTP/1.1 200 OK
Content-Type: application/json
    
{
    "id": "n8qX7ZMx6LOg5DQj",
    "name": "Regular",
    "event_id": "oLenyp2qBMRAQVY5",
    "dates": [
        {
            "id": "k5r6PGEojmMLvKwm",
            "starts_at": "2021-07-03T22:00:00.000000Z",
            "ends_at": "2021-07-03T22:00:00.000000Z"
        },
        {
            "id": "5Nk7n02Rbd2ad3Lx",
            "starts_at": "2021-07-02T13:00:00.000000Z",
            "ends_at": "2021-07-02T21:00:00.000000Z"
        }
    ],
    "price": "49.99",
    "capacity": 1000,
    "min_order_amount": 1,
    "max_order_amount": 5,
    "template_id": "5NZGx32KbOJqQmBV",
    "mobile_template_id": "wmjpk1Egm26APR4l",
    "service_fee": 0,
    "availability": [],
    "fields": [],
    "related_tickets": [],
    "excluded_tickets": [],
    "sale_percentage": {
        "active": true,
        "percentage": 55
    },
    "on_fire": true,
    "is_hidden": false,
    "is_entry": true
}