Create calendar access rule - Automate.ax

createCalendarAccessRule grants one principal or public scope a calendar role.

Example

import { automation, onHttpRequest } from "automate.ax"
import { createCalendarAccessRule } from "automate.ax/google-calendar"

export default automation("Share a team calendar", () => {
  onHttpRequest({ scope: "automation" })

  createCalendarAccessRule({
    calendar: "Team Calendar",
    scope: { type: "group", value: "launch@example.com" },
    role: "writer",
    sendNotifications: true,
  })
})

Inputs

Property	Type	Required	Default	Description
`scope`	`{ type: "user" \| "group" \| "domain"; value: string } \| { type: "default" }`	Yes	—	Recipient or public scope. `default` means public and must not include a value.
`role`	`"none" \| "freeBusyReader" \| "reader" \| "writer" \| "owner"`	Yes	—	Permission to grant.
`calendar`	`string`	No	`"primary"`	Exact title or ID.
`sendNotifications`	`boolean`	No	Google default	Whether Google emails the recipient.
`account`	Google account reference	No	Project default	Connected account.

Output

Returns the created { id, role, scope }. Preserve id for updates or deletion.

A default scope can make the calendar public. Grant owner only when transferring owner-level control is intended and supported by Google.

⌘I