MS Entra – Events – Cancel Event
MS Entra – Events – Cancel Event
Cancel an event and send a cancellation message to attendees.
Action details
| Property | Value |
|---|---|
| Action label | MS Entra – Events – Cancel Event |
| Category | CloudTools |
| Apex class and method | CancelMSGraphEvent.cancelEvent |
| Input type | CancelMSGraphEvent.CancelMSGraphEventInput |
| Output type | List<CancelMSGraphEvent.CancelMSGraphEventOutput> |
| Authorization | Microsoft 365 connector; supported authorization depends on the endpoint and target. |
| Microsoft Graph request | POST /me/calendar/events/{eventId}/cancel or the selected user/calendar path; group event path where exposed |
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, not all are least privileged, and a scope can have target-specific restrictions. Check the Microsoft operation reference before selecting permissions.
| Permission type | Declared alternatives |
|---|---|
| Delegated | Calendars.ReadWrite |
| Application | Calendars.ReadWrite |
Endpoints: /me/calendar/events/{event-id}/cancel; /me/calendars/{calendar-id}/events/{event-id}/cancel; /users/{idOrUserPrincipalName}/calendar/events/{event-id}/cancel; /users/{idOrUserPrincipalName}/calendars/{calendar-id}/events/{event-id}/cancel; /groups/{group-id}/events/{event-id}/cancel. The listed permissions document user calendars; the action also exposes a group-event endpoint whose permission requirements are not separately specified in this operation reference.
See the Microsoft operation and permissions reference.
Inputs
| Input | Apex field | Type | Required | Description |
|---|---|---|---|---|
| User Email | userEmail | String | No | Email address of the user |
| Group Id | groupId | String | No | Group identifier (not group email) |
| Event Id | eventId | String | Yes | Event identifier |
| Calendar Id | calendarId | String | No | Calendar identifier (leave empty for default calendar) |
| Comment | comment | String | No | Comment to include with the cancellation (can be empty) |
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 operation result after the call returns. Inspect success and message; an accepted or started operation may still require completion checks. Exceptions are generally thrown for failures rather than returned as success=false.
| Output | Apex field | Type | Description |
|---|---|---|---|
| Success | success | Boolean | Whether the cancel succeeded |
| Message | message | String | Result message |
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.
Cancel and delete have different organizer/attendee effects. Cancellation is intended for an organizer and can notify attendees; deleting an event is a separate Graph operation. Confirm the event identity and meeting role.
Use in Flow
Use MS Entra – Events – Cancel Event 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.CancelMSGraphEvent.CancelMSGraphEventInput request =
new Apptigent.CancelMSGraphEvent.CancelMSGraphEventInput();
request.userEmail = 'someone@example.com';
request.eventId = 'AAMkAGI2TAAA=';
request.calendarId = 'calendar-id';
request.comment = 'Cancelling for this week due to all hands.';
List<Apptigent.CancelMSGraphEvent.CancelMSGraphEventOutput> results =
Apptigent.CancelMSGraphEvent.cancelEvent(
new List<Apptigent.CancelMSGraphEvent.CancelMSGraphEventInput>{ request }
);
System.debug(results);
Use in a Lightning Web Component
Use cancelMSGraphEvent 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 input | LWC request mapping |
|---|---|
userEmail | request.userIdOrPrincipalName |
groupId | request.groupId |
eventId | request.eventId |
calendarId | request.calendarId |
comment | request.comment |
entraActionExample.js
import { LightningElement } from 'lwc';
import { cancelMSGraphEvent } 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.eventId = 'AAMkAGI2TAAA=';
request.calendarId = 'calendar-id';
request.comment = 'Cancelling for this week due to all hands.';
this.result = await cancelMSGraphEvent(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
| Symptom | What to check |
|---|---|
| Required fields error | Supply a nonempty request list and required or conditionally required inputs. For LWC, use the mapped field names. |
| Authorization or access denied | Check connector selection, sign-in, endpoint/target permission support, administrator consent, directory roles, and resource access. |
| Resource not found | Check Microsoft IDs and parent resource relationships. Preserve group/drive/item associations and mailbox/calendar/event IDs. |
| Missing or unexpected output | Check query support, pagination, wrapper versus item models, public-only properties, and mapped DTO fields. |
| Operation rejected | Inspect the Microsoft error, supported writable fields, group/calendar restrictions, recipient/license data, and file transfer limits. |