Update Calendar

post

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

Update a calendar's settings. Only the provided fields are changed. Pass null or an empty string to clear the website or a social handle.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

calendar_id

string

required

Calendar ID, this usually starts with cal-.

name

string

Name of the calendar.

launch_status

string

enum

Calendar status: launched means Active; coming-soon shows a placeholder page; archived stops new follows and visitor event submissions.

Allowed:

slug

string

URL slug for the calendar page (e.g. 'my-community' → lu.ma/my-community).

description

string

Short description of the calendar.

avatar_url

uri

Specify an image that has been uploaded to the Luma CDN.

tint_color

string

Tint color for the calendar in hex format (e.g. '#E3CBEF').

website

string | null

Website URL. https:// is added if missing.

instagram_handle

string | null

Instagram handle or profile URL (e.g. 'luma' or 'https://instagram.com/luma').

twitter_handle

string | null

X (Twitter) handle or profile URL (e.g. '@luma' or 'https://x.com/luma').

youtube_handle

string | null

YouTube handle or channel URL (e.g. '@luma' or 'https://youtube.com/@luma').

tiktok_handle

string | null

TikTok handle or profile URL (e.g. '@luma' or 'https://tiktok.com/@luma').

linkedin_handle

string | null

LinkedIn company or profile URL (e.g. 'https://linkedin.com/company/luma').

location

null

City the calendar is based in. Use { type: 'lookup', query } to search Google Maps for a city, or { type: 'google', place_id } with a city's Google Places ID. The calendar's timezone and coordinate come from the city. Pass null to clear it.

event_defaults

object

Settings new events on this calendar start with. Only the provided fields change, and existing events aren't affected. visibility: 'members-only' requires a membership tier on the calendar.

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response.