Create Event

post

https://public-api.luma.com/v1/events/create

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

confirmation_email_md

string

Your message in the confirmation email, sent when a registration is confirmed, including when you approve a guest. Supports Markdown formatting. Leave this field out to keep the current message or use the default email for a new event. To remove your message, use an empty string (""). Guests will still receive the standard email.

pending_approval_email_md

string

Your message in the email sent to guests awaiting approval or joining the waitlist. Supports Markdown formatting. Leave this field out to keep the current message or use the default email for a new event. To remove your message, use an empty string (""). Guests will still receive the standard email.

declined_email_md

string

Your message in the email sent when you decline a guest's registration. Supports Markdown formatting. Leave this field out to keep the current message or use the default email for a new event. To remove your message, use an empty string (""). Guests will still receive the standard email.

can_register_for_multiple_tickets

boolean

Whether a guest can register for multiple tickets in one registration (Group Registration). When true, each ticket counts toward max_capacity.

cover_url

string

^https:\/\/images\.lumacdn\.com\/.*

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, or pick one from Luma’s cover gallery with /v1/images/search.

create_meeting

string

enum

Create a new Zoom meeting or Google Meet with the Zoom or Google account the user has connected to Luma, and use its join link as the event's meeting_url. Fails if that account isn't connected. On update, replaces the current link; only the event's creator can create a Zoom meeting. Can't be combined with meeting_url or geo_address_json.

Allowed:

description_md

string

Format your text with Markdown. For images, request an upload URL from /v1/images/create-upload-url, upload the image, and use the returned file_url in ![alt](url). Image URLs must be hosted on images.lumacdn.com. To embed a YouTube, Vimeo, or Loom video, put its URL on a line of its own. Embedded Luma event cards aren't supported.

end_at

date-time

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

font

enum

Font for the event name and headings on the event page. Setting a theme without a font applies the theme’s default font; pass null to clear the font and use the standard font. Fonts may be retired over time — a retired font stops being accepted here, and event pages still using one fall back to the standard font.

geo_address_json

In-person location. Use { type: 'manual', address } with a free-text address, { type: 'google', place_id } with a Google Places ID, or { type: 'lookup', query } to search Google Maps and use the top result. Leave out for online events.

location_visibility

string

enum

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.

Allowed:

max_capacity

number | null

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_url

string

Join link for online events (Zoom, Google Meet, etc.). To have Luma create one, use create_meeting instead. Can't be combined with geo_address_json.

name

string

required

name_requirement

string

enum

How to collect guest names: full-name uses a single field; first-last uses separate first and last name fields. Enabling first-last requires Luma Plus on the event's calendar.

Allowed:

phone_number_requirement

enum

registration_open

boolean

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

registration_questions

array of objects

registration_questions

reminders_disabled

boolean

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

feedback_email

object

Settings for the post-event feedback email sent to guests. If not specified on create, inherits from calendar defaults.

show_guest_list

boolean

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

slug

string

length between 3 and 50

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_at

date-time

required

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

theme

string

enum

Theme for the event page. Themes may be retired over time — a retired theme stops being accepted here, and event pages still using one fall back to standard. Setting a theme also applies the theme’s default font unless you pass font.

timezone

string

required

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

tint_color

string

Accent color for the event page, as a 3 or 6-digit hex code like #bb2dc7. We adjust the shade as needed so text and buttons stay accessible against the background.

visibility

string

enum

Allowed:

waitlist_status

string

enum

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

Allowed:

ticket_types

array of objects

length between 1 and 200

Ticket types to create the event with. When provided, these replace the default ticket — the event is created with exactly these ticket types. When omitted, the event gets a single free ticket named Standard. Paid ticket types require the calendar to have a connected Stripe account. To change ticket types after creation, use the ticket type endpoints.

ticket_types

name

string

required

length between 1 and 30

require_approval

boolean

is_hidden

boolean

description

length ≤ 1000

valid_start_at

null

valid_end_at

null

max_capacity

number | null

type

string

enum

required

Allowed:

cents

0 to 9007199254740991

Price in the currency's minor unit (e.g. 2500 for $25.00). Required for paid ticket types.

currency

string | null

ISO 4217 currency code like usd. Required for paid ticket types.

is_flexible

boolean

Pay-what-you-want pricing: guests choose an amount of at least min_cents.

min_cents

0 to 9007199254740991

Minimum amount for pay-what-you-want pricing, in the currency's minor unit.

200Successful response.