Update calendarPermission
Namespace: microsoft.graph
Important
APIs under the /beta
version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Update the permissions assigned to an existing share recipient or delegate, through the corresponding calendarPermission object for a calendar.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Permissions
Depending on the type of calendar that the event is in and the permission type (delegated or application) requested, one of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.
Calendar | Delegated (work or school account) | Delegated (personal Microsoft account) | Application |
---|---|---|---|
user calendar | Calendars.ReadWrite | Calendars.ReadWrite | Calendars.ReadWrite |
group calendar | Group.ReadWrite.All | Not supported. | Not supported. |
HTTP request
Update the specified permissions of a user's calendar:
PATCH /users/{id}/calendar/calendarPermissions/{id}
Update the specified permissions of a group calendar:
PATCH /groups/{id}/calendar/calendarPermissions/{id}
Update the specified permissions of the user calendar that contains the identified event:
PATCH /users/{id}/events/{id}/calendar/calendarPermissions/{id}
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Content-Type | application/json. Required. |
Request body
In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed.
Property | Type | Description |
---|---|---|
role | calendarRoleType | The permission level to change to for the calendar share recipient or delegate. |
Response
If successful, this method returns a 200 OK
response code and an updated calendarPermission object in the response body.
Examples
Request
The following example changes the permission level of the share recipient, Adele, to write
.
PATCH https://graph.microsoft.com/beta/users/{id}/calendar/calendarPermissions/RGVmYXVsdA==
Content-type: application/json
{
"role": "write"
}
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-type: application/json
{
"id": "RGVmYXVsdA==",
"isRemovable": true,
"isInsideOrganization": true,
"role": "write",
"allowedRoles": [
"freeBusyRead",
"limitedRead",
"read",
"write"
],
"emailAddress": {
"name": "Adele Vance",
"address": "AdeleV@contoso.com"
}
}
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for