Add User to Calendar

Add a user to a shared Google Calendar.

For this action card to complete successfully, the Google Calendar connection called by this card must use the calendar owner's credentials.

Scopes

See Action cards for the list of required OAuth scopes for this card.

Options

Field Definition Type Required

Calendar

Select the calendar where you want to add the user.

Dropdown

TRUE

Send Notification?

Indicates if a notification is sent to the user after being added to the shared Google Calendar.

True/False

TRUE

Input

Field Definition Type Required

User

Email

Email address of the user.

Text

TRUE

Role

Role of the user.

  • none: The user has no access.

  • freeBusyReader: The user has read access to free or busy information.

  • reader: The user has read access to the calendar. Private events appear to users with reader access, but event details are hidden.

  • writer: The user has read and write access to the calendar. Private events appear to users with writer access, and event details are visible.

  • owner: The user has ownership of the calendar. This role has the same permissions as the writer role, with the additional ability to see and manipulate Access Control Lists (ACLs).

Dropdown

TRUE

After being assigned to the user, the calendar doesn't automatically appear in their calendar list.

A user can add a newly assigned calendar with the Add this calendar link in the email notification.

Output

Field Definition Type

Status Code

Result of the operation. The connector returns an HTTP status code that indicates whether the action taken by the card succeeded or failed. For example:

  • A 201 Created status code indicates success where a new resource was created.
  • A 403 Forbidden error indicates that the HTTP request wasn't processed because the necessary permissions were missing.

For a full list of possible status codes, see HTTP status codes.

Number

Access Rule

ID

Identifier of the ACL rule.

Text

Scope

How much calendar access is granted through the ACL rule.

Object

Type

Type of data returned.

  • 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.

The permissions granted to the default scope apply to any user, authenticated or not.

Text

Value

The email address of a user or group, or the name of a domain, depending on the scope type.

Omitted if the Type field is set to default.

Text

Related topics

Google Calendar connector

Cards in flows

Google Calendar API documentation