MS Entra – Calendars – Update Calendar

Estimated reading: 6 minutes

MS Entra – Calendars – Update Calendar

Update a calendar for a user or group.

Action details

PropertyValue
Action labelMS Entra – Calendars – Update Calendar
CategoryCloudTools
Apex class and methodUpdateMSGraphCalendar.updateCalendar
Input typeUpdateMSGraphCalendar.UpdateMSGraphCalendarInput
Output typeList<MSGraphCalendar>
AuthorizationMicrosoft 365 connector; supported authorization depends on the endpoint and target.
Microsoft Graph requestPATCH /me/calendar or /me/calendars/{calendarId}; /users/{userEmail}/calendar or /users/{userEmail}/calendars/{calendarId}; group target where supported by the action

Prerequisites and permissions

Configure a CloudTools Connector with Connector Type set to Microsoft 365. Complete sign-in for OAuth Delegated (Authorization Code). For supported OAuth Application (Client Credentials) requests, grant application permissions and administrator consent. The identity must have access to the selected resource; directory operations can also require Microsoft Entra roles. Use Creating an Entra ID App and Integration Connectors for setup.

The action permission provider declares these alternatives. They are not cumulative requirements or universally interchangeable; check the Microsoft reference for endpoint, target, and property restrictions.

Permission typeDeclared alternatives
DelegatedCalendars.ReadWrite, Group.ReadWrite.All
ApplicationCalendars.ReadWrite

Endpoints: /me/calendar or /me/calendars/{calendarId}; /users/{userEmail}/calendar or /users/{userEmail}/calendars/{calendarId}; group target where supported by the action. Calendars.ReadWrite applies to user calendars. Group.ReadWrite.All applies to group calendars with delegated access; application access to group calendars is not supported.

See the Microsoft operation and permissions reference.

Inputs

InputApex fieldTypeRequiredDescription
User EmailuserEmailStringNoEmail address of the user
Group IdgroupIdStringNoGroup identifier
Calendar IdcalendarIdStringNoCalendar identifier
NamenameStringNoCalendar name
ColorcolorStringNoCalendar color
Change KeychangeKeyStringNoChange key
Can EditcanEditBooleanNoWhether the user can edit the calendar
Can SharecanShareBooleanNoWhether the user can share the calendar
Can View Private ItemscanViewPrivateItemsBooleanNoWhether private items are visible
Owner NameownerNameStringNoOwner display name
Owner EmailownerEmailStringNoOwner email address

Supply a nonempty list with a non-null first request. Graph actions process only that first request. Global inputs do not expose connectorId; subscriber Apex and Flow use CloudTools connector selection. Use Microsoft Graph resource IDs or the specifically documented user identifier, and resolve dynamic values before invocation.

Outputs

Returns one mapped MSGraphCalendar inside a list. Check the actual result shape and fields before use. This implementation creates a default result object when the response is null; an object alone does not prove that a resource was returned.

OutputApex fieldTypeDescription
IdidStringCalendar id
NamenameStringCalendar name
ColorcolorStringCalendar color
Change KeychangeKeyStringChange key
Can EditcanEditBooleanWhether the user can edit the calendar
Can SharecanShareBooleanWhether the user can share the calendar
Can View Private ItemscanViewPrivateItemsBooleanWhether private items are visible
OwnerownerMSGraphCalendarEmailCalendar owner

Behavior and limits

Delegated authorization can select /me for user-calendar operations. Outside delegated access, supply the target user required by runtime validation; optional invocable user fields can still be conditionally required.

Use either the user target or Group Id as documented; the action rejects supplying both. Group calendar/event support differs from user calendars and generally requires delegated group permissions. A group endpoint exposed by the connector is not a guarantee that every calendar operation is supported there.

Use in Flow

Use MS Entra – Calendars – Update Calendar where supported. Use a Microsoft 365 application connector configured as Set as default for Flow automations only if the endpoint and target support application access. Supply required values, retain useful outputs, and add fault handling. Delegated connections are not supported for CloudTools Flow automation. The action processes only the first input request.

Use in custom Apex

This subscriber-org example uses the Apptigent namespace. Replace identifiers and example values before use. Configure the connector, complete authorization first, run in a context permitting callouts, and handle exceptions, empty results, and unmapped fields.

Apptigent.UpdateMSGraphCalendar.UpdateMSGraphCalendarInput request =
    new Apptigent.UpdateMSGraphCalendar.UpdateMSGraphCalendarInput();
request.userEmail = 'someone@example.com';
request.calendarId = 'AAMkAGI2TAAA=';
request.name = 'Calendar';
request.color = 'auto';
request.ownerName = 'Adele Vance';
request.ownerEmail = 'adele.vance@example.com';



List<Apptigent.MSGraphCalendar> results =
    Apptigent.UpdateMSGraphCalendar.updateCalendar(
        new List<Apptigent.UpdateMSGraphCalendar.UpdateMSGraphCalendarInput>{ request }
    );
System.debug(results);

Use in a Lightning Web Component

Use updateMSGraphCalendar from msEntraConnectorLib through MSEntraConnectorController. These c/ imports apply in the same namespace. Set request.connectorId for direct MSEntraAction calls. The controller captures the request selection for MSEntraAction.

Global inputLWC request mapping
userEmailrequest.userIdOrPrincipalName
groupIdrequest.groupId
calendarIdrequest.calendarId
namerequest.name
colorrequest.color
changeKeyrequest.changeKey
canEditrequest.canEdit
canSharerequest.canShare
canViewPrivateItemsrequest.canViewPrivateItems
ownerNamerequest.ownerName
ownerEmailrequest.ownerEmail

entraActionExample.js

import { LightningElement } from 'lwc';
import { updateMSGraphCalendar } from 'c/msEntraConnectorLib';

export default class EntraActionExample extends LightningElement {
    result = null;
    errorMessage = '';
    isRunning = false;
    completed = false;

    async handleRun() {
        if (this.isRunning || this.completed) return;
        this.isRunning = true;
        this.errorMessage = '';
        try {
            const request = { connectorId: 'REPLACE_WITH_CONNECTOR_RECORD_ID' };
            request.userIdOrPrincipalName = 'someone@example.com';
            request.calendarId = 'AAMkAGI2TAAA=';
            request.name = 'Calendar';
            request.color = 'auto';
            request.ownerName = 'Adele Vance';
            request.ownerEmail = 'adele.vance@example.com';
            this.result = await updateMSGraphCalendar(request);
            this.completed = true;
        } catch (error) {
            this.errorMessage = error.requiresInteractiveAuthorization
                ? 'Sign in to Microsoft for the connector, then try again.'
                : error.message || 'The Entra action failed.';
        } finally {
            this.isRunning = false;
        }
    }
}

entraActionExample.html

<template>
    <lightning-button label="Run action" onclick={handleRun}
        disabled={isRunning}></lightning-button>
    <p role="alert">{errorMessage}</p>
</template>

The library returns one mapped DTO or null. The controller can flatten nested fields, serialize data, or map an action result into an operation DTO. rawJson contains serialized mapped Apex data rather than the untouched Graph response.

Use getMSEntraAuthorizationState, beginMSEntraAuthorization, and createMSEntraOAuthMessageHandler to arrange delegated sign-in. The library normalizes errors but does not automatically sign in or retry. Reset completed for a new deliberate operation, and inspect resource state before retrying a mutation with an uncertain outcome.

Error handling and troubleshooting

SymptomWhat to check
Required fields errorSupply a nonempty request list and required or conditionally required inputs. For LWC, use the mapped field names.
Authorization or access deniedCheck connector selection, sign-in, endpoint/target permission support, administrator consent, directory roles, and resource access.
Resource not foundCheck Microsoft IDs and parent resource relationships. Preserve group/drive/item associations and mailbox/calendar/event IDs.
Missing or unexpected outputCheck query support, pagination, wrapper versus item models, public-only properties, and mapped DTO fields.
Operation rejectedInspect the Microsoft error, supported writable fields, group/calendar restrictions, recipient/license data, and file transfer limits.

See Entra connector introduction.

Share this Doc

MS Entra – Calendars – Update Calendar

Or copy link

CONTENTS

Free eBook: The Ultimate Guide to Power Platform Custom Connectors

Antimanual

Ask our AI support assistant your questions about our platform, features, and services.

You are offline
Chatbot avatar
What can I help you with?

Subscribe

×
Cancel