--- title: "Change event series status" method: POST path: "/v1/event_series/{event_series_id}/status" tags: ["Event series"] --- # Change event series status `POST /v1/event_series/{event_series_id}/status` For the given event series ID, change its status ## Path parameters - `event_series_id` string, required ## Response `200` Successfully updated the event series status - EventSeries - `object` string - `id` string — A unique identifier for the event series - `access_code` string, nullable — Code to access a protected event series - `bundles` Bundle[], nullable — List of associated bundles - `object` string - `id` string - `access_code` string, nullable — Code to access a bundle - `booking_fee` integer — Booking fee in cents - `description` string — Bundle description - `group_id` string, nullable — Bundle group ID - `name` string — Bundle name - `price` integer — Price in cents - `products` object[] — Array of associated products - `id` string — A unique product identifier - `quantity` integer — Product quantity - `status` 'HIDDEN' | 'UNAVAILABLE' | 'ON_SALE' | 'SOLD_OUT' — Bundle status - `ticket_types` object[] — Array of associated ticket types - `id` string — A unique ticket type identifier - `quantity` integer — Ticket type quantity - `call_to_action` string — Call to action text used on the event series page - `created_at` object — Date and time when the event series were created - `date` string — ISO-8601 date for the end of the event - `formatted` string — A formatted date string for the end of the event - `iso` string — ISO-8601 date and time for the end of the event - `time` string — Time of the end of the event - `timezone` string — Timezone offset for the end of the event - `unix` integer — Unix timestamp for for the end of the event - `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_occurrence` integer, nullable — Maximum quantity of tickets that can be sold across all ticket types - `default_ticket_groups` TicketGroup[], nullable — Ticket groups that are not overridden - `object` string - `id` string — A unique identifier for the ticket group - `bundle_ids` string[], nullable — An array of associated bundle ids - `max_per_order` integer, nullable — Maximum number of tickets allowed per order - `max_quantity` integer, nullable — Maximum quantity of tickets that are allowed to be sold for the tickets in the group - `min_per_order` integer, nullable — Minimum number of tickets allowed per order - `name` string — Name of the ticket group - `sort_order` integer — Sort index of the group in the UI - `ticket_ids` string[] — An array of associated ticket type ids - `default_ticket_types` TicketType[], nullable — Ticket types that are not overridden - `object` string, required - `id` string, required — A unique identifier for the ticket type - `access_code` string, nullable, required — Code to access a hidden ticket - `booking_fee` integer, required — Optional booking fee which is charged per ticket type to the customer and the funds are paid to you. - `description` string, nullable, required - `discounts` string[] — An array of associated discounts - `group_id` string, nullable, required — ID of the group this ticket type belongs to - `has_overrides` 'true' | 'false' — Specifies whether the ticket type has overrides - `hide_after` object, nullable — Timestamp in seconds when the ticket type should be hidden until. - `date` string — ISO-8601 date for the start of the event - `formatted` string — A formatted date string for the start of the event - `iso` string — ISO-8601 date and time for the start of the event - `time` string — Time for the start of the event - `timezone` string — Timezone offset for the start of the event - `unix` integer — Unix timestamp for the start of the event - `hide_until` object, nullable — Timestamp in seconds when the ticket type should be hidden after. - `date` string — ISO-8601 date for the start of the event - `formatted` string — A formatted date string for the start of the event - `iso` string — ISO-8601 date and time for the start of the event - `time` string — Time for the start of the event - `timezone` string — Timezone offset for the start of the event - `unix` integer — Unix timestamp for the start of the event - `hide_when_sold_out` 'true' | 'false' — Specifies whether the ticket is hidden when it has sold out - `max_per_order` integer, required — Maximum number of ticket types you can select per order - `min_per_order` integer, required — Minimum number of ticket types you can select per order - `name` string, required — Name of the ticket type - `override_id` string, nullable — The ID of the override associated with the ticket type - `price` union, required — Cost of the ticket type - integer - number - `show_quantity_remaining` 'true' | 'false' — Specifies whether to show the number of tickets still available - `show_quantity_remaining_less_than` integer, nullable — Only show number of tickets still available when the available quantity is equal to or lower than this threshold - `status` 'on_sale' | 'sold_out' | 'unavailable' | 'hidden' | 'admin_only' | 'locked', required — Status of the ticket type - `sort_order` integer, required — Sort index of ticket type in the UI - `type` 'paid' | 'free', required - `quantity` integer, required — Number available for purchase - `quantity_held` integer, required — Number held - `quantity_in_baskets` integer — Number in baskets - `quantity_issued` integer, required — Number issued - `quantity_total` integer, required — Total number including issued and still available - `description` string, nullable — Description of the event series - `images` object — Imagages that have been uploaded to this event series - `header` string — Image URL of the header image used on the event series page - `thumbnail` string — Image URL of the thumbnail used on the event series page - `name` string — Name of the event series - `next_occurrence_date` object — Date and time when the next event in the series happens - `date` string — ISO-8601 date for the end of the event - `formatted` string — A formatted date string for the end of the event - `iso` string — ISO-8601 date and time for the end of the event - `time` string — Time of the end of the event - `timezone` string — Timezone offset for the end of the event - `unix` integer — Unix timestamp for for the end of the event - `online_event` string — Returns whether or not the event is online - `payment_methods` object[] — An array of payment methods - `external_id` string — A unique identifier for the payment method - `id` string — A unique identifier for internal payment methods - `type` 'stripe' | 'paypal' | 'offline' — The type of payment method - `name` string — Name of the payment method - `instructions` string — Instructions for the customer on how to pay. Used for offline payments. - `private` string — Returns whether or not the event is private - `revenue` number — Total revenue of the event series - `show_map` string — 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_label` string, nullable — The label for the sales tax - `sales_tax_percentage` integer, 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 - `timezone` string — TZ format timezone string - `total_occurrences` integer — Total number of time the event series occurs - `total_issued_tickets` integer — Total number of issued tickets - `transaction_fee_fixed_amount` integer, nullable — Fixed amount of the transaction fee - `transaction_fee_percentage` integer, nullable — Percentage of the transaction fee - `upcoming_occurrences` integer — The number of upcoming occurrences of the event series - `url` string — Event series URL - `tickets_available_at` object — Date when tickets become available for purchase - `date` string — ISO-8601 date for the end of the event - `formatted` string — A formatted date string for the end of the event - `iso` string — ISO-8601 date and time for the end of the event - `time` string — Time of the end of the event - `timezone` string — Timezone offset for the end of the event - `unix` integer — Unix timestamp for for the end of the event - `tickets_available_at_message` string — Message to show when tickets are not yet available to purchase. {countdown} is replaced with time remaining until tickets become available - `tickets_unavailable_at` object — Date when tickets become unavailable for purchase - `date` string — ISO-8601 date for the end of the event - `formatted` string — A formatted date string for the end of the event - `iso` string — ISO-8601 date and time for the end of the event - `time` string — Time of the end of the event - `timezone` string — Timezone offset for the end of the event - `unix` integer — Unix timestamp for for the end of the event - `tickets_unavailable_at_message` string — Message to show when tickets are unavailable to purchase - `venue` object - `country` string, nullable — Country of the venue - `name` string, nullable — Name of the venue - `postal_code` string, nullable — Postal code of the venue - `voucher_ids` string[] — List of voucher IDs - `waitlist_active` 'true' | 'no_tickets_available' | 'false' — Indicates whether waitlist is enabled for the event series - `waitlist_call_to_action` string — The text displayed on event action buttons and as a title above the waitlist format - `waitlist_event_page_text` string — Description above ticket waitlist form - `waitlist_confirmation_message` string — Text shown to the user after they have signed up to the waitlist ## Other responses - `default` — Error schema --- [API](https://skmtc.net/tickettailor/apis/ticket-tailor-api.md) · [All operations](https://skmtc.net/tickettailor/apis/ticket-tailor-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tickettailor/ticket-tailor-api/revisions/7b222e8ec91c/schema)