Sign in

v13

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-012612103.2 KB
Events

Create an event

Creates a new event under the specified schedule. Requires a Pro plan. The authenticated user must be an owner or admin of the schedule. For venue schedules, the venue is automatically set. For talent schedules, the member is automatically set.

post/events/{subdomain}

Path parameters

subdomainstring required

The subdomain identifier of the schedule to create the event under

Request body

namestring

Event name (required for create)

starts_atstring

Start date and time in UTC (Y-m-d H:i:s format, required for create)

durationnumber

Event duration in hours

descriptionstring

Full event description (supports markdown)

short_descriptionstring

Brief event description

event_urlstring uri

External URL for the event

event_passwordstring

Password to protect the event page

is_privateboolean nullable

Make event private (hidden from calendar, only accessible via direct link)

registration_urlstring uri

External registration URL

category_idinteger

Category ID from /categories

categorystring

Category name (alternative to category_id)

tickets_enabledboolean

Whether to enable ticket sales

ticket_currency_codestring

3-letter ISO currency code for tickets

payment_method'stripe' | 'invoiceninja' | 'payment_url' | 'manual'

Payment method for ticket sales

payment_instructionsstring

Instructions for manual payment

schedule_type'single' | 'recurring'

Whether this is a single or recurring event

recurring_frequency'daily' | 'weekly' | 'every_n_weeks' | 'monthly_date' | 'monthly_weekday' | 'yearly'

Recurrence frequency (required when schedule_type is recurring)

recurring_intervalinteger

Interval for every_n_weeks frequency

recurring_end_type'never' | 'on_date' | 'after_events'

How the recurrence should end

recurring_end_valuestring

End date (Y-m-d) for on_date, or number of occurrences for after_events

days_of_weekstring

7-character string where each position represents a day (Sunday to Saturday), '1' means the event recurs on that day. Only used with weekly or every_n_weeks frequency.

venue_idstring

Encoded ID of a venue schedule to associate with the event

venue_namestring

Venue name (used to look up an existing venue schedule)

venue_address1string

Venue address (used together with venue_name to look up an existing venue schedule)

schedulestring

Sub-schedule slug to assign this event to

Example request

{
  "starts_at": "2025-06-15 19:00:00",
  "ticket_currency_code": "USD",
  "days_of_week": "0101010"
}

Response

Event created successfully

Example response

{
  "data": {
    "days_of_week": "0101010"
  },
  "meta": {
    "message": "Event created successfully"
  }
}