Skip to content

Microsoft: Invoke action forward — users Calendar Group user Calendar Groups Calendars Events Forward

Microsoft usersCalendarGroup.userCalendarGroupsCalendarsEventsForward: arguments, response, policy and SDK examples.

← Users calendar group operations · Get started

Operation microsoft.users_user_calendargroups_calendargroup_calendars_calendar_events_event_forward

Provider route: POST /users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/forward. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/microsoft with npm, or alter-sdk-microsoft with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { MicrosoftIntegration } from "@alter-ai/microsoft";
async function execute(input: Parameters<MicrosoftIntegration["usersCalendarGroup"]["userCalendarGroupsCalendarsEventsForward"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new MicrosoftIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.usersCalendarGroup.userCalendarGroupsCalendarsEventsForward(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_microsoft import MicrosoftIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = MicrosoftIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.users_calendar_group.user_calendar_groups_calendars_events_forward(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.user-idstringRequired within parent
path.calendarGroup-idstringRequired within parent
path.calendar-idstringRequired within parent
path.event-idstringRequired within parent
bodyobjectRequired within parent
body.CommentJSONOptional
body.Comment (anyOf 1)stringAlternative
body.Comment (anyOf 2)nullAlternative
body.ToRecipientsarrayOptional
body.ToRecipients[]ModelEach itemExpand Invoke action forward — me Event events Forward — request body — body To Recipients item

Referenced models: Invoke action forward — me Event events Forward — request body — body To Recipients item

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$nullRoot
Invoke action forward — me Event events Forward — request body — body To Recipients item
FieldTypePresenceDescription and constraints
$objectRootdiscriminator: {"mapping": {"#microsoft.graph.attendee": "#/components/schemas/microsoft.graph.attendee", "#microsoft.graph.attendeeBase": "#/components/schemas/microsoft.graph.attendeeBase"}, "propertyName": "@odata.type"}
@odata.typestringOptional
emailAddressJSONOptionalThe recipient's email address.
emailAddress (anyOf 1)ModelAlternativeExpand Get calendar Permission — response body — @odata type, allowed Roles, email Address, is Inside Organization, is Removable, role email Address @odata type, address, name
emailAddress (anyOf 2)JSONAlternative
emailAddress (anyOf 2) (anyOf 1)objectAlternative
emailAddress (anyOf 2) (anyOf 2)nullAlternative

Referenced models: Get calendar Permission — response body — @odata type, allowed Roles, email Address, is Inside Organization, is Removable, role email Address @odata type, address, name

Get calendar Permission — response body — @odata type, allowed Roles, email Address, is Inside Organization, is Removable, role email Address @odata type, address, name
FieldTypePresenceDescription and constraints
$objectRoot
@odata.typestringOptional
addressJSONOptional
address (anyOf 1)stringAlternativeThe email address of the person or entity.
address (anyOf 2)nullAlternative
nameJSONOptional
name (anyOf 1)stringAlternativeThe display name of the person or entity.
name (anyOf 2)nullAlternative

SDK function policy ID: microsoft.users_user_calendargroups_calendargroup_calendars_calendar_events_event_forward. Catalog operation: users_user_calendargroups_calendargroup_calendars_calendar_events_event_forward. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["Calendars.Read"]

No-content response statuses: [204]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.