Acl: update

Updates an access control rule. Try it now.

Request

HTTP request

PUT https://www.googleapis.com/calendar/v3/calendars/calendarId/acl/ruleId

Parameters

Parameter name Value Description
Path parameters
calendarId string Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
ruleId string ACL rule identifier.
Optional query parameters
sendNotifications boolean Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.

Authorization

This request requires authorization with at least one of the following scopes:

Scope
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.acls

For more information, see the authentication and authorization page.

Request body

In the request body, supply an Acl resource with the following properties:

Property name Value Description Notes
Required Properties
scope object The extent to which calendar access is granted by this ACL rule.
scope.type string The type of the scope. Possible values are:
  • "default" - The public scope. This is the default value.
  • "user" - Limits the scope to a single user.
  • "group" - Limits the scope to a group.
  • "domain" - Limits the scope to a domain.
Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
Optional Properties
role string The role assigned to the scope. Possible values are:
  • "none" - Provides no access.
  • "freeBusyReader" - Provides read access to free/busy information.
  • "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
  • "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. Provides read access to the calendar's ACLs.
  • "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to manipulate ACLs.
 writable
scope.value string The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default". writable

Response

If successful, this method returns an Acl resource in the response body.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.