v1

latestOpenAPI 3.1.0Proprietary2026-07-24660315.0 KB

Events

Create Event

post/v1/events/create

Request body

can_register_for_multiple_ticketsboolean

cover_urlstring uri

Specify an image that has been uploaded to the Luma CDN. You can upload an image after getting an upload URL from the Luma API.

description_mdstring

Luma stores rich text in a special format called Spark. We don't expose an API for that format, but we can convert Markdown to Spark for you. Some Spark features, like Luma event embeds, are not supported by Markdown. Images are supported using standard markdown syntax ( alt ) — image URLs must be hosted on the Luma CDN (images.lumacdn.com). Upload images via the /v1/images/create-upload-url endpoint first.

end_atstring date-time

ISO 8601 Datetime. For example, 2022-10-19T03:27:13.673Z

location_visibility'public' | 'guests-only'

Set to guests-only to hide the precise location from people who haven't been approved — they'll see only the city and approximate area. Defaults to public.

max_capacitynumber nullable

Once an event hits the max capacity, the event will be marked as sold out and registration will automatically be closed.

If the event has a waitlist (waitlist_status is enabled), new registrations join the waitlist instead of being closed.

If can_register_for_multiple_tickets is true, each ticket will count towards the max capacity.

meeting_urlstring

namestring required

name_requirement'full-name' | 'first-last'

Luma collects the name of every guest as they register. Choose if you'd like to split this into two fields to encourage guests to enter their first and last name.

phone_number_requirement'optional' | 'required' nullable

registration_openboolean

Whether to accept registrations. Set to false to close registration so new guests can't sign up. Defaults to true.

reminders_disabledboolean

By default, Luma will send reminders before the event. Turn off if you'd like more control over event communications.

show_guest_listboolean

When the guest list is shown, approved guests will be able to see who else is going to the event.

slugstring

The URL slug for the event. If the slug is aloha, the URL will be https://luma.com/aloha. If the slug is not available, the event creation will fail.

You can use /v1/entities/lookup to check if a slug is available.

start_atstring date-time required

ISO 8601 Datetime. For example, 2022-10-19T03:27:13.673Z

timezonestring required

IANA Timezone, e.g. America/New_York. https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

tint_colorstring

A hex color like '#bb2dc7'. Alpha channels (#rgba, #rrggbbaa) are automatically stripped.

visibility'public' | 'members-only' | 'private'

waitlist_status'disabled' | 'enabled'

enabled if the event has a waitlist. New registrations join the waitlist once the event reaches capacity.

Response

Successful response.

idstring required

All 75 operations