Update Event

post

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

event_id

string

required

Event ID, this usually starts with evt-

suppress_notifications

boolean

If true, Luma will not notify guests (via email or push notification) when updating the event name, time, or location.

can_register_for_multiple_tickets

boolean

cover_url

uri

^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.

coordinate

object

description_md

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. YouTube, Vimeo and Loom videos are embedded by putting the video URL on a line of its own.

end_at

date-time

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

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

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

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

name

string

name_requirement

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:

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

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

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

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:

Response

200Successful response.