Tool ID:
luma_post_v1_events_updateRun this action
Use the TypeScript SDK for a single call. Putctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.
CLI
Example response
The static output schema is not detailed enough to generate a reliable example. Usedeepline tools get luma_post_v1_events_update --json for the complete live contract.
Input reference
Update Event| Name | Type | Required | Default | Details |
|---|---|---|---|---|
payload.event_id | string | Yes | — | Event ID, this usually starts with evt- |
payload.suppress_notifications | boolean | No | — | If true, Luma will not notify guests (via email or push notification) when updating the event name, time, or location. |
payload.can_register_for_multiple_tickets | boolean | No | — | Whether a guest can register for multiple tickets in one registration (Group Registration). When true, each ticket counts toward max_capacity. |
payload.cover_url | string | No | — | 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. Format: uri. Pattern: ^https:\/\/images\.lumacdn\.com\/.*. |
payload.coordinate | object | No | — | — |
payload.description_md | string | No | — | 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 ( ) — 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 See the live schema for the complete constraint. |
payload.end_at | string | No | — | ISO 8601 Datetime. For example, 2022-10-19T03:27:13.673Z Format: date-time. |
payload.font | "alternate" | "alverata" | "avant-garde" | "beaufort" | "blithe" | "caslon" | "degular" | "departure" | "factoria" | "futura" | "garamond" | "geist-mono" | "google" | "ivy-mode" | "ivy-presto" | "museo" | "neuzeit" | "new-spirit" | "poster" | "roc-grotesk" | "snpro" | "strenuous" | "pearl" | No | — | 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. Allowed: alternate, alverata, avant-garde, beaufort, blithe, caslon, degular, departure, factoria, futura, garamond, geist-mono, google, ivy-mode, See the live schema for the complete constraint. |
payload.geo_address_json | object | No | — | — |
payload.location_visibility | "public" | "guests-only" | No | — | 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: public, guests-only. |
payload.max_capacity | number | No | — | 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. |
payload.meeting_url | string | No | — | — |
payload.name | string | No | — | — |
payload.name_requirement | "full-name" | "first-last" | No | — | 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: full-name, first-last. |
payload.phone_number_requirement | "optional" | "required" | No | — | Allowed: optional, required. |
payload.registration_open | boolean | No | — | Whether to accept registrations. Set to false to close registration so new guests can’t sign up. Defaults to true. |
payload.registration_questions | array | No | — | — |
payload.reminders_disabled | boolean | No | — | By default, Luma will send reminders before the event. Turn off if you’d like more control over event communications. |
payload.feedback_email | object | No | — | Settings for the post-event feedback email sent to guests. If not specified on create, inherits from calendar defaults. |
payload.show_guest_list | boolean | No | — | When the guest list is shown, approved guests will be able to see who else is going to the event. |
payload.slug | string | No | — | 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. Minimum length: 3. Maximum length: 50. |
payload.start_at | string | No | — | ISO 8601 Datetime. For example, 2022-10-19T03:27:13.673Z Format: date-time. |
payload.theme | "standard" | "cross" | "diamond" | "falling-leaves" | "fireworks" | "floral" | "grain-dark" | "grain-light" | "grid" | "bats" | "holiday-diwali" | "holiday-foliage" | "holiday-hanukkah" | "holiday-pie" | "holiday-santa" | "holiday-sweater" | "holiday-turkey" | "hypnotic" | "life" | "matrix" | "particles-bokeh" | "particles-champagne" | "plus" | "iridescent-dark" | "iridescent-light" | "polkadot" | "pool-dark" | "pool-light" | "snake" | "snow-dark" | "snow-light" | "space-war" | "sunny-shades" | "tamagotchi" | "warp" | "wave" | "zigzag" | No | — | 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. Allowed: standard, cross, diamond, falling-leaves, fireworks, floral, grain-dark, grain-light, grid, bats, holiday-diwali, holiday-foliage, holiday-hanukkah, holiday-pie, holiday-santa, holiday-sweater, holiday-turkey, See the live schema for the complete constraint. |
payload.timezone | string | No | — | IANA Timezone, e.g. America/New_York. https://en.wikipedia.org/wiki/List_of_tz_database_time_zones |
payload.tint_color | string | No | — | 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. |
payload.visibility | "public" | "members-only" | "private" | No | — | Allowed: public, members-only, private. |
payload.waitlist_status | "disabled" | "enabled" | No | — | enabled if the event has a waitlist. New registrations join the waitlist once the event reaches capacity. Allowed: disabled, enabled. |
This input schema is too large to embed without slowing the page. Get the complete live contract with
deepline tools get luma_post_v1_events_update --json.Output reference
Standard tool result payload.Deepline cost
- Pricing model:
fixed(per call). - Estimated Deepline credits:
0per pricing unit. - Provider-native pricing may still exist outside Deepline credit billing.