API Reference

Create Event

post
https://public-api.luma.com/v1/event/create
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
boolean
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.

coordinate
object
string

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.

date-time

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

geo_address_json
-9007199254740991 to 9007199254740991

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

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

string
string
required
string
enum

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.

Allowed:
enum
registration_questions
array
registration_questions
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.

boolean

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

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 /public/v1/entity/lookup to check if a slug is available.

date-time
required

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

string
required

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

string

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

string
enum
Allowed:
Response

Updated 2 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 days ago