Operation

Create Event

POST/events

Create a new event within your organisation. Events are the top-level entity that represents a ticketed experience - a concert, conference, sporting event, or any occasion where you'll sell tickets. After creating an event, you'll typically want to: 1. Add **occurrences** (specific dates and times) 2. Configure **price schemes** (ticket types and pricing) 3. Set the event status to `published` when ready to sell

When to use this

Creating events programmatically from an external calendar or booking system
Bulk importing events from a CSV or spreadsheet
Building a custom event management interface
Automating event creation based on venue schedules

Headers

Idempotency-KeystringOptional: Makes the write safe to retry. The first request with a key does the work and its response is stored for 24 hours; a repeat with the same key and the same request (method, path, query, X-Ticketlayer-Channel, TL-Version and body) gets that stored status and body back, marked `Idempotent-Replay: true`, without running again. The key is scoped to your organisation and your credential. The same key with a different request is 422 IDEMPOTENCY_KEY_REUSED; a repeat while the first is still running waits for it, then answers 409 IDEMPOTENT_REQUEST_IN_PROGRESS if it has not finished. Only a 2xx is stored: after an error the key is free again. Omit the header and the request behaves as it always has.

Body

accountId*stringAccount ID that owns this event

name*stringEvent name

subtitlestringnullShort event subtitle / tagline

descriptionstringEvent description

shortDescriptionstringnullCard / listing summary

imageUrlstring,null (uri)Listing / card image URL

heroImageUrlstring,null (uri)Event-page hero image URL

presentationobjectnullEvent-level storefront design override

▶heroLayoutobject

▶cinemaGradientobject

twoColumnSplitarray

▶navbarobject

buttonSize"small" | "medium" | "large"

venueIdstringnullVenue ID (link to formal venue)

venueNamestringnullVenue name (text-only, alternative to venueId)

timezonestringEvent timezone

▼rulesobjectThe three listing states for this event, each a rule; an omitted state is open. A channel listing inherits each unless it overrides it.

discoverableany

visibleany

sellableany

tagsstring[]Event tags

▼ticketTypesobject[]Ticket types for this event (e.g., Adult, Child)

idstringTicket type ID (auto-generated if not provided)

name*stringTicket type name

descriptionstringTicket type description

displayOrder*integerDisplay order

tagsstring[]Ticket-type tags, by slug: each a defined tag that applies to ticket_types (400 TAG_NOT_DEFINED or TAG_NOT_APPLICABLE otherwise). What fee rules key on, the same in every event

visibility"public" | "locked" | "hidden"Price visibility for this type's cells (TKT-336): public (shown and buyable), locked (shown with how to unlock it, buyable once unlocked) or hidden (not shown to a buyer until unlocked). A cell can override it. Absent keeps the type's current visibility

unlockTagsstring[]Customer tags (slugs), any one of which unlocks a locked or hidden price of this type; each must be a defined tag that applies to customers. Absent keeps the current ones

taxCategory"admission" | "admission_exempt" | "donation" | "non_taxable"What admission of this type is taxed as: admission (the standard rate in the UK), admission_exempt (an eligible cultural or sporting body), donation or non_taxable (outside the scope). Absent keeps the current one; a new type is admission

▼layoutobjectEvent layout with categories and capacity areas

▶categoriesobject[]Pricing categories for this event

▶areasobject[]Capacity areas (GA and/or allocated)

venueLayoutTemplateIdstringSource venue layout template ID (if imported)

Returns

Event created successfully

Errors

400: Bad Request - Invalid input
401: Unauthorized - Authentication required
403: Forbidden - Insufficient permissions
404: Not Found - Resource not found
500: Internal Server Error

Every error names its code and links to it. All error codes

Notes

Note

Events must belong to a venue. Make sure to create the venue first if it doesn't exist.

Tip

Use a descriptive `slug` for SEO-friendly URLs. If not provided, one will be generated from the event name.

Important

Events are created in `draft` status by default. Update the status to `published` when ready for ticket sales.

import { BackstageClient } from '@ticketlayer/backstage';const client = new BackstageClient({  organisationSlug: 'your-org',});client.setAccessToken('YOUR_ACCESS_TOKEN');// Create a new eventconst event = await client.events.create({  name: 'Summer Festival 2025',  slug: 'summer-festival-2025',  venueId: 'venue_abc123',  description: 'The biggest music festival of the summer!',  status: 'draft',});console.log(`Created event: ${event.id}`);// Now add occurrences and price schemes...

Response 201

{
  "event": {
    "id": "evt_abc123",
    "organisationId": "org_xyz789",
    "accountId": "acc_def456",
    "name": "Summer Music Festival",
    "subtitle": "Three days. Fifty artists. One field.",
    "description": "A three-day music festival",
    "shortDescription": "Top artists across three days.",
    "status": "draft",
    "images": {
      "card": {
        "url": "https://api.ticketlayer.com/assets/o/org_xyz789/tempest-card.jpg",
        "width": null,
        "height": null,
        "alt": "The Tempest",
        "contentType": "image/jpeg"
      },
      "hero": null
    },
    "imageUrl": "https://api.ticketlayer.com/assets/o/org_xyz789/tempest-card.jpg",
    "heroImageUrl": null,
    "presentation": {
      "heroLayout": {
        "type": "cinema",
        "size": "large"
      },
      "buttonSize": "large"
    },
    "venueId": "vnu_ghi789",
    "venueName": "The Globe",
    "timezone": "Europe/London",
    "rules": {
      "discoverable": {
        "open": true,
        "windows": [
          {
            "from": null,
            "until": null,
            "audienceTags": [],
            "audience": null
          }
        ]
      },
      "visible": {
        "open": true,
        "windows": [
          {
            "from": null,
            "until": null,
            "audienceTags": [],
            "audience": null
          }
        ]
      },
      "sellable": {
        "open": true,
        "windows": [
          {
            "from": null,
            "until": null,
            "audienceTags": [],
            "audience": null
          }
        ]
      }
    },
    "ticketTypes": [
      {
        "id": "tty_abc123",
        "name": "Adult",
        "description": "Ages 16+",
        "displayOrder": 0,
        "visibility": "hidden",
        "unlockTags": [
          "member"
        ],
        "requiredBenefit": "member",
        "tags": [
          "child"
        ],
        "taxCategory": "admission"
      }
    ],
    "defaultPriceSchemeId": "tps_abc123",
    "occurrenceCount": 3,
    "ticketCount": 0,
    "productCount": 0,
    "tags": [
      "music",
      "festival"
    ],
    "isDeleted": false,
    "createdAt": "2024-12-28T10:30:00Z",
    "updatedAt": "2024-12-28T14:45:00Z",
    "contentUpdatedAt": "2024-12-29T09:12:44.512Z",
    "createdBy": "usr_abc123",
    "version": 14
  }
}

Create Event

When to use this

Headers

Body

Returns

Errors

Notes

Related

Try it in test mode

Body