Sign in
latestOpenAPI 3.1.12026-08-108026304.2 KB

7b222e8ec91c

Event series

Create an event series

Creates a new event series

post/v1/event_series

Response

Successfully created a new event series

objectstring
idstring

A unique identifier for the event series

access_codestring nullable

Code to access a protected event series

call_to_actionstring

Call to action text used on the event series page

currency'gbp' | 'usd' | 'eur' | 'sgd' | 'aud' | 'brl' | 'cad' | 'czk' | 'dkk' | 'hkd' | 'huf' | 'ils' | 'jpy' | 'myr' | 'mxn' | 'nok' | 'nzd' | 'php' | 'pln' | 'rub' | 'sek' | 'chf' | 'twd' | 'thb' | 'try'

Information about the currency the event series is configured to use

default_max_tickets_sold_per_occurrenceinteger nullable

Maximum quantity of tickets that can be sold across all ticket types

descriptionstring nullable

Description of the event series

namestring

Name of the event series

online_eventstring

Returns whether or not the event is online

privatestring

Returns whether or not the event is private

revenuenumber

Total revenue of the event series

show_mapstring

Returns whether or not the map should be shown on the event series page. It depends if venue location is set and if the event is not online and hide map is not set in the event series.

sales_tax_labelstring nullable

The label for the sales tax

sales_tax_percentageinteger nullable

The percentage of the sales tax

sales_tax_treatment'inclusive' | 'exclusive' nullable

The treatment of the sales tax

status'draft' | 'published' | 'sales_closed'

Status of the event

timezonestring

TZ format timezone string

total_occurrencesinteger

Total number of time the event series occurs

total_issued_ticketsinteger

Total number of issued tickets

transaction_fee_fixed_amountinteger nullable

Fixed amount of the transaction fee

transaction_fee_percentageinteger nullable

Percentage of the transaction fee

upcoming_occurrencesinteger

The number of upcoming occurrences of the event series

urlstring

Event series URL

tickets_available_at_messagestring

Message to show when tickets are not yet available to purchase. {countdown} is replaced with time remaining until tickets become available

tickets_unavailable_at_messagestring

Message to show when tickets are unavailable to purchase

voucher_idsstring[]

List of voucher IDs

waitlist_active'true' | 'no_tickets_available' | 'false'

Indicates whether waitlist is enabled for the event series

waitlist_call_to_actionstring

The text displayed on event action buttons and as a title above the waitlist format

waitlist_event_page_textstring

Description above ticket waitlist form

waitlist_confirmation_messagestring

Text shown to the user after they have signed up to the waitlist

Example response

{
  "object": "event_series",
  "id": "es_1",
  "access_code": null,
  "bundles": null,
  "call_to_action": "Buy tickets / Join the guestlist",
  "currency": "gbp",
  "default_max_tickets_sold_per_occurrence": null,
  "default_ticket_groups": [
    {
      "object": "ticket_group",
      "id": "tg_21099",
      "bundle_ids": [
        "bu_123"
      ],
      "max_per_order": 10,
      "max_quantity": 100,
      "min_per_order": 1,
      "name": "April 20th",
      "sort_order": 50050,
      "ticket_ids": [
        "tt_230625",
        "tt_230626"
      ]
    },
    {
      "object": "ticket_group",
      "id": "tg_21100",
      "bundle_ids": [
        "bu_4"
      ],
      "max_per_order": 10,
      "max_quantity": 100,
      "min_per_order": 1,
      "name": "April 21st",
      "sort_order": 50100,
      "ticket_ids": [
        "tt_230631",
        "tt_230632"
      ]
    }
  ],
  "default_ticket_types": [
    {
      "object": "ticket_type",
      "id": "tt_230625",
      "access_code": null,
      "booking_fee": 0,
      "description": null,
      "group_id": "tg_21099",
      "max_per_order": 100,
      "min_per_order": 1,
      "name": "4.20 Adult (13-61) - Presale",
      "price": 800,
      "status": "hidden",
      "sort_order": 50050,
      "type": "paid",
      "quantity": 10000,
      "quantity_held": 0,
      "quantity_issued": 5000,
      "quantity_total": 15000
    },
    {
      "object": "ticket_type",
      "id": "tt_230626",
      "access_code": null,
      "booking_fee": 0,
      "description": null,
      "group_id": "tg_21099",
      "max_per_order": 100,
      "min_per_order": 1,
      "name": "4.20 Senior (62+) - Presale",
      "price": 600,
      "status": "on_sale",
      "sort_order": 50051,
      "type": "paid",
      "quantity": 10000,
      "quantity_held": 0,
      "quantity_issued": 2000,
      "quantity_total": 12000
    },
    {
      "object": "ticket_type",
      "id": "tt_230631",
      "access_code": null,
      "booking_fee": 0,
      "description": null,
      "group_id": "tg_21100",
      "max_per_order": 100,
      "min_per_order": 1,
      "name": "4.21 Adult (13-61) - Presale",
      "price": 800,
      "status": "on_sale",
      "sort_order": 50100,
      "type": "paid",
      "quantity": 10000,
      "quantity_held": 0,
      "quantity_issued": 4000,
      "quantity_total": 14000
    },
    {
      "object": "ticket_type",
      "id": "tt_230632",
      "access_code": null,
      "booking_fee": 0,
      "description": null,
      "group_id": "tg_21100",
      "max_per_order": 100,
      "min_per_order": 1,
      "name": "4.21 Senior (62+) - Presale",
      "price": 600,
      "status": "on_sale",
      "sort_order": 50101,
      "type": "paid",
      "quantity": 10000,
      "quantity_held": 0,
      "quantity_issued": 1000,
      "quantity_total": 11000
    }
  ],
  "description": null,
  "images": {
    "header": "https://d37ecpm5it19bz.cloudfront.net/c_crop,dpr_1.0,h_1921,q_100,w_1922,x_479,y_0/c_scale,g_center,h_326,q_85,w_1024/v1/stitching/userfiles/acfi9eknr1vur6wguu5s.jpg",
    "thumbnail": "https://d37ecpm5it19bz.cloudfront.net/c_crop,dpr_1.0,h_1921,q_100,w_1922,x_479,y_0/c_scale,h_108,q_85,w_108/v1/stitching/userfiles/acfi9eknr1vur6wguu5s.jpg"
  },
  "name": "Hackney Downs 2020 Tulip Festival",
  "next_occurrence_date": {
    "date": "2020-05-01",
    "formatted": "Fri 1 May 2020 10:30 PM",
    "iso": "2020-05-01T22:30:00+01:00",
    "time": "22:30",
    "timezone": "+01:00",
    "unix": 1588368600
  },
  "online_event": "false",
  "payment_methods": [
    {
      "external_id": null,
      "id": "pm_6687",
      "instructions": "Pay when you arrive to festival",
      "name": "Pay on the door",
      "type": "offline"
    },
    {
      "external_id": "seller222@example.com",
      "id": "pm_6691",
      "instructions": null,
      "name": null,
      "type": "paypal"
    }
  ],
  "private": "false",
  "revenue": 165,
  "sales_tax_label": "VAT",
  "sales_tax_percentage": 20,
  "sales_tax_treatment": "exclusive",
  "show_map": "true",
  "status": "published",
  "timezone": "Europe/London",
  "total_occurrences": 20,
  "total_issued_tickets": 5,
  "transaction_fee_fixed_amount": null,
  "transaction_fee_percentage": 10,
  "tickets_available_at": {
    "date": "2020-05-01",
    "formatted": "Fri 1 May 2020 10:30 PM",
    "iso": "2020-05-01T22:30:00+01:00",
    "time": "22:30",
    "timezone": "+01:00",
    "unix": 1588368600
  },
  "tickets_available_at_message": "Tickets are available in {countdown}",
  "tickets_unavailable_at": {
    "date": "2020-05-02",
    "formatted": "Sat 2 May 2020 10:30 PM",
    "iso": "2020-05-02T22:30:00+01:00",
    "time": "22:30",
    "timezone": "+01:00",
    "unix": 1588455000
  },
  "tickets_unavailable_at_message": "Tickets are no longer available",
  "upcoming_occurrences": 5,
  "url": "https://www.tickettailor.com/events/flowerfestival/40980",
  "venue": {
    "country": "GB",
    "name": "Flower festival gardens",
    "postal_code": "SW1 3BR"
  },
  "voucher_ids": [
    "vo_123",
    "vo_345",
    "vo_567"
  ],
  "waitlist_active": "true",
  "waitlist_call_to_action": "Join waiting list",
  "waitlist_event_page_text": "Join our waiting list to be notified when tickets become available.",
  "waitlist_confirmation_message": "Done! You are on the waiting list."
}