> ## Documentation Index
> Fetch the complete documentation index at: https://alhwyn.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Update calendar

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

<Badge color="purple">SDK</Badge> `luma.calendar.update(calendarId, params): Promise<Calendar>`

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

<RequestExample>
  ```typescript Example theme={null}
  const calendar = await luma.calendar.get();

  await luma.calendar.update(calendar.api_id, {
    name: "My events calendar",
  });
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "api_id": "cal-abc123",
    "name": "My events calendar"
  }
  ```
</ResponseExample>

### Parameters

<ParamField path="calendarId" type="string" required>
  Calendar ID from `calendar.get().api_id`.
</ParamField>

<ParamField path="params" type="CalendarUpdateParams" required>
  Fields to update. See the [official Luma API docs](https://docs.luma.com) for available fields.
</ParamField>

### Test it

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