Skip to main content

Create a ticket type

POST 

https://api.tickettailor.com/v1/event_series/:event_series_id/ticket_types

For the given event series ID, create a ticket type

Request

Path Parameters

    event_series_id stringrequired

    The unique identifier for the event series

Bodyrequired

    access_codestring

    Code to access a hidden ticket

    Example: secret_code_123
    booking_feeinteger

    Optional booking fee which is charged per ticket type to the customer and the funds are paid to you. We would recommend charging no more than 10% of the ticket price.

    Example: 155
    descriptionstring

    Description of the ticket type

    Example: General admission ticket
    discountsstring[]

    List of associated discount IDs

    Example: ["di_123","di_456"]
    hide_afterinteger

    Timestamp in seconds when the ticket type should be hidden until.

    Example: 1744001007
    hide_untilinteger

    Timestamp in seconds when the ticket type should be hidden after.

    Example: 1744001007
    hide_when_sold_outboolean

    Hide the ticket when it has sold out

    Example: ["true","false"]
    max_per_orderinteger

    Maximum number of tickets allowed per order

    Example: 20
    min_per_orderinteger

    Minimum number of tickets allowed per order

    Example: 1
    namestringrequired

    Name of the ticket type

    Example: General Admission
    priceintegerrequired

    Cost of the ticket type

    Example: 600
    quantityintegerrequired

    Number of ticket types available for purchase

    Example: 55
    show_quantity_remainingstring

    Specifies whether to show the number of tickets still available

    Possible values: [true, false]

    show_quantity_remaining_less_thaninteger

    Only show number of tickets still available when the available quantity is equal to or lower than this threshold

    statusstring

    Event series status

    Possible values: [ON_SALE, SOLD_OUT, UNAVAILABLE, HIDDEN, ADMIN_ONLY, LOCKED]

    group_idstring

    ID of the group this ticket type belongs to

    Example: gt_54434

Responses

Successfully created a ticket type

Schema
    objectstringrequired
    idstringrequired

    A unique identifier for the ticket type

    access_codestringnullablerequired

    Code to access a hidden ticket

    booking_feeintegerrequired

    Optional booking fee which is charged per ticket type to the customer and the funds are paid to you.

    descriptionstringnullablerequired
    discountsstring[]

    An array of associated discounts

    group_idstringnullablerequired

    ID of the group this ticket type belongs to

    has_overridesstring

    Specifies whether the ticket type has overrides

    Possible values: [true, false]

    hide_after objectnullable

    Timestamp in seconds when the ticket type should be hidden until.

    datestring

    ISO-8601 date for the start of the event

    formattedstring

    A formatted date string for the start of the event

    isostring

    ISO-8601 date and time for the start of the event

    timestring

    Time for the start of the event

    timezonestring

    Timezone offset for the start of the event

    unixinteger

    Unix timestamp for the start of the event

    hide_until objectnullable

    Timestamp in seconds when the ticket type should be hidden after.

    datestring

    ISO-8601 date for the start of the event

    formattedstring

    A formatted date string for the start of the event

    isostring

    ISO-8601 date and time for the start of the event

    timestring

    Time for the start of the event

    timezonestring

    Timezone offset for the start of the event

    unixinteger

    Unix timestamp for the start of the event

    hide_when_sold_outstring

    Specifies whether the ticket is hidden when it has sold out

    Possible values: [true, false]

    max_per_orderintegerrequired

    Maximum number of ticket types you can select per order

    min_per_orderintegerrequired

    Minimum number of ticket types you can select per order

    namestringrequired

    Name of the ticket type

    override_idstringnullable

    The ID of the override associated with the ticket type

    price objectrequired

    Cost of the ticket type

    anyOf
    integer
    show_quantity_remainingstring

    Specifies whether to show the number of tickets still available

    Possible values: [true, false]

    show_quantity_remaining_less_thanintegernullable

    Only show number of tickets still available when the available quantity is equal to or lower than this threshold

    statusstringrequired

    Status of the ticket type

    Possible values: [on_sale, sold_out, unavailable, hidden, admin_only, locked]

    sort_orderintegerrequired

    Sort index of ticket type in the UI

    typestringrequired

    Possible values: [paid, free]

    quantityintegerrequired

    Number available for purchase

    quantity_heldintegerrequired

    Number held

    quantity_in_basketsinteger

    Number in baskets

    quantity_issuedintegerrequired

    Number issued

    quantity_totalintegerrequired

    Total number including issued and still available

Authorization: http

name: BasicAuthtype: httpdescription: Use base64 encoded api key created in Ticket Tailor dashboard.
scheme: basic
curl -L -X POST 'https://api.tickettailor.com/v1/event_series/:event_series_id/ticket_types' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
Request Collapse all
Base URL
https://api.tickettailor.com
Auth
Parameters
— pathrequired
Body required
required
required
required