Skip to content

Add-GSCalendarSubscription

SYNOPSIS

Adds a calendar to a users calendar list (aka subscribes to the specified calendar)

SYNTAX

Add-GSCalendarSubscription [-User] <String> [-CalendarId] <String[]> [-ColorRgbFormat] [-Selected] [-Hidden]
 [-Reminders <EventReminder[]>] [-DefaultReminderMethod <String>] [-DefaultReminderMinutes <Int32>]
 [-Notifications <CalendarNotification[]>] [-DefaultNotificationMethod <String>]
 [-DefaultNotificationType <String>] [-Color <String>] [-SummaryOverride <String>] [<CommonParameters>]

DESCRIPTION

Adds a calendar to a users calendar list (aka subscribes to the specified calendar)

EXAMPLES

EXAMPLE 1

Add-GSCalendarSubscription -User me -CalendarId john.smith@domain.com -Selected -Color Cyan

Adds the calendar 'john.smith@domain.com' to the AdminEmail user's calendar list

PARAMETERS

-User

The primary email or UserID of the user. You can exclude the '@domain.com' to insert the Domain in the config or use the special 'me' to indicate the AdminEmail in the config.

Type: System.String
Parameter Sets: (All)
Aliases: PrimaryEmail, UserKey, Mail

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-CalendarId

The calendar ID of the calendar you would like to subscribe the user to

Type: System.String[]
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ColorRgbFormat

Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Selected

Whether the calendar content shows up in the calendar UI. Optional. The default is False.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Hidden

Whether the calendar has been hidden from the list. Optional. The default is False.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Reminders

A list of reminders to add to this calendar.

This parameter expects a 'Google.Apis.Calendar.v3.Data.EventReminder[]' object type. You can create objects of this type easily by using the function 'Add-GSCalendarEventReminder'

Type: Google.Apis.Calendar.v3.Data.EventReminder[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DefaultReminderMethod

The method used by this reminder. Defaults to email.

Possible values are: * "email" - Reminders are sent via email. * "sms" - Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. * "popup" - Reminders are sent via a UI popup.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DefaultReminderMinutes

Number of minutes before the start of the event when the reminder should trigger. Defaults to 30 minutes.

Valid values are between 0 and 40320 (4 weeks in minutes).

Type: System.Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 30
Accept pipeline input: False
Accept wildcard characters: False

-Notifications

A list of notifications to add to this calendar.

This parameter expects a 'Google.Apis.Calendar.v3.Data.CalendarNotification[]' object type. You can create objects of this type easily by using the function 'Add-GSCalendarNotification'

Type: Google.Apis.Calendar.v3.Data.CalendarNotification[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DefaultNotificationMethod

The method used to deliver the notification.

Possible values are: * "email" - Reminders are sent via email. * "sms" - Reminders are sent via SMS. This value is read-only and is ignored on inserts and updates. SMS reminders are only available for G Suite customers.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DefaultNotificationType

The type of notification.

Possible values are: * "eventCreation" - Notification sent when a new event is put on the calendar. * "eventChange" - Notification sent when an event is changed. * "eventCancellation" - Notification sent when an event is cancelled. * "eventResponse" - Notification sent when an event is changed. * "agenda" - An agenda with the events of the day (sent out in the morning).

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Color

The color of the calendar.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SummaryOverride

The summary that the authenticated user has set for this calendar.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

Google.Apis.Calendar.v3.Data.CalendarListEntry

NOTES

https://psgsuite.io/Function%20Help/Calendar/Add-GSCalendarSubscription/

https://developers.google.com/calendar/v3/reference/calendarList/insert

Back to top