Update calendar

Important: APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported.

Update the properties of calendar object.


One of the following scopes is required to execute this API: Calendars.ReadWrite

HTTP request

A user's or group's default calendar.

PATCH /me/calendar
PATCH /users/{id | userPrincipalName}/calendar
PATCH /groups/{id}/calendar

A user's calendar in the default calendarGroup.

PATCH /me/calendars/{id}
PATCH /users/{id | userPrincipalName}/calendars/{id}

PATCH /me/calendarGroup/calendars/{id}
PATCH /users/{id | userPrincipalName}/calendarGroup/calendars/{id}

A user's calendar in a specific calendarGroup.

PATCH /me/calendarGroups/{id}/calendars/{id}
PATCH /users/{id | userPrincipalName}/calendarGroups/{id}/calendars/{id}

Request headers

Header Value
Authorization Bearer {token}. Required.
Content-Type application/json. Required.

Request body

In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.

Property Type Description
color String Specifies the color theme to distinguish the calendar from other calendars in a UI. The property values are: LightBlue=0, LightGreen=1, LightOrange=2, LightGray=3, LightYellow=4, LightTeal=5, LightPink=6, LightBrown=7, LightRed=8, MaxColor=9, Auto=-1
isDefaultCalendar Boolean True if this calendar is the user's default calendar, false otherwise.
name String The calendar name.


If successful, this method returns a 200 OK response code and updated calendar object in the response body.



Here is an example of the request.

PATCH https://graph.microsoft.com/beta/me/calendar
Content-type: application/json

  "name": "Social events"

Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 200 OK
Content-type: application/json

    "name":"Social events",
    "hexColor": "",
        "name":"Fanny Downs",