Update calendar

Patch Luma calendar settings like name, description, and timezone using luma.calendar.update(calendarId, params) in the TypeScript SDK.

Example

const calendar = await luma.calendar.get();

await luma.calendar.update(calendar.api_id, {
  name: "My events calendar",
});

Response

{
  "api_id": "cal-abc123",
  "name": "My events calendar"
}

SDK luma.calendar.update(calendarId, params): Promise<Calendar>

Updates calendar settings. Pass the api_id from calendar.get() as calendarId.

Example

const calendar = await luma.calendar.get();

await luma.calendar.update(calendar.api_id, {
  name: "My events calendar",
});

Response

{
  "api_id": "cal-abc123",
  "name": "My events calendar"
}

Parameters

calendarId · string · required

Calendar ID from calendar.get().api_id.

params · CalendarUpdateParams · required

Fields to update. See the official Luma API docs for available fields.

Test it

Run calendar.get() first to read the current name, then call update() with a test value on a non-production calendar.