Change event series status

POST https://api.tickettailor.com/v1/event_series/:event_series_id/status

For the given event series ID, change its status

Request

Path Parameters

event_series_id stringrequired

The unique identifier for the event series

application/x-www-form-urlencoded

Bodyrequired

statusstringrequired

New event series status

Possible values: [DRAFT, PUBLISHED, CLOSE_SALES]

Responses

200
default

Successfully updated the event series status

application/json

Schema
Example (auto)

Schema

objectstring

idstring

A unique identifier for the event series

access_codestringnullable

Code to access a protected event series

bundles object[]nullable

call_to_actionstring

Call to action text used on the event series page

created_at

currencystring

Information about the currency the event series is configured to use

Possible values: [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]

default_max_tickets_sold_per_occurrenceintegernullable

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

default_ticket_groups undefined[]

default_ticket_types object[]nullable

Ticket types that are not overridden

Array [

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

hide_until objectnullable

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

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

]

descriptionstringnullable

Description of the event series

images

namestring

Name of the event series

next_occurrence_date

online_eventstring

Returns whether or not the event is online

Possible values: [true, false]

payment_methods undefined[]

privatestring

Returns whether or not the event is private

Possible values: [true, false]

revenuenumber

Total revenue of the event series

Possible values: >= 0

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.

Possible values: [true, false]

sales_tax_labelstringnullable

The label for the sales tax

sales_tax_percentageintegernullable

The percentage of the sales tax

sales_tax_treatmentstringnullable

The treatment of the sales tax

Possible values: [inclusive, exclusive]

statusstring

Status of the event

Possible values: [draft, published, sales_closed]

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_amountintegernullable

Fixed amount of the transaction fee

transaction_fee_percentageintegernullable

Percentage of the transaction fee

upcoming_occurrencesinteger

The number of upcoming occurrences of the event series

urlstring

Event series URL

tickets_available_at

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

tickets_unavailable_at_messagestring

Message to show when tickets are unavailable to purchase

venue

voucher_idsstring[]

List of voucher IDs

waitlist_activestring

Indicates whether waitlist is enabled for the event series

Possible values: [true, no_tickets_available, false]

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

{
  "object": "event_series",
  "id": "es_1",
  "access_code": null,
  "call_to_action": "Buy tickets / Join the guestlist",
  "currency": "gbp",
  "default_max_tickets_sold_per_occurrence": null,
  "default_ticket_groups": [
    {
      "id": "tg_21099",
      "max_per_order": null,
      "name": "April 20th",
      "sort_order": 50050,
      "ticket_ids": [
        "tt_230625",
        "tt_230626"
      ]
    },
    {
      "id": "tg_21100",
      "max_per_order": null,
      "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."
}

Error schema

application/json

Schema
Example (auto)

Schema

statusintegerrequired

Http status code

error_codestringrequired

Readable error code

messagestringrequired

Detailed error message

errors object[]

{
  "status": 0,
  "error_code": "string",
  "message": "string",
  "errors": [
    {
      "field": "string",
      "messages": [
        "string"
      ]
    }
  ]
}

Authorization: http

name: BasicAuthtype: httpdescription: Use base64 encoded api key created in Ticket Tailor dashboard.
scheme: basic

CURL

curl -L -X POST 'https://api.tickettailor.com/v1/event_series/:event_series_id/status' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'

Change event series status

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

Request​

Path Parameters

Bodyrequired

Responses​

Authorization: http

Request

Responses