API Reference

Update Event

post
https://public-api.luma.com/v1/events/update
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Event ID, this usually starts with evt-

boolean

If true, Luma will not email guests when updating the event name, time, or location. Guests still get a push notification for a changed time or location.

boolean
deprecated

Use suppress_email instead.

object | null

Tax added on top of ticket prices for this event only, overriding the calendar’s tax setting. Pass null to go back to the calendar’s setting. Requires Luma Pro on the event’s calendar. Only affects new purchases.

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.

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.

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.

boolean

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

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.

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

date-time

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

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.

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

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.

string
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:
enum
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
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 /v1/entities/lookup to check if a slug is available.

date-time

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

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.

string

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

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.

string
enum
Allowed:
string
enum

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

Allowed:
Response

Updated 4 months ago

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

Updated 4 months ago

Did this page help you?