event: forward

Namespace: microsoft.graph

This action allows the organizer or attendee of a meeting event to forward the meeting request to a new recipient.

If the meeting event is forwarded from an attendee's Microsoft 365 mailbox to another recipient, this action also sends a message to notify the organizer of the forwarding, and adds the recipient to the organizer's copy of the meeting event. This convenience is not available when forwarding from an Outlook.com account.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) Calendars.Read Not available.
Delegated (personal Microsoft account) Calendars.Read Not available.
Application Calendars.Read Not available.

HTTP request

POST /me/events/{id}/forward
POST /users/{id | userPrincipalName}/events/{id}/forward
POST /groups/{id}/events/{id}/forward

POST /me/calendar/events/{id}/forward
POST /users/{id | userPrincipalName}/calendar/events/{id}/forward
POST /groups/{id}/calendar/events/{id}/forward

POST /me/calendars/{id}/events/{id}/forward
POST /users/{id | userPrincipalName}/calendars/{id}/events/{id}/forward

POST /me/calendarGroups/{id}/calendars/{id}/events/{id}/forward
POST /users/{id | userPrincipalName}/calendarGroups/{id}/calendars/{id}/events/{id}/forward

Request headers

Name Type Description
Authorization string Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type string Nature of the data in the body of an entity. Required.

Request body

In the request body, provide a JSON object with the following parameters.

Parameter Type Description
Comment String A comment to include. Can be an empty string.
ToRecipients recipient collection The list of recipients to forward the event to.

Response

If successful, this method returns 202 Accepted response code. It doesn't return anything in the response body.

Example

Here is an example of how to call this API.

Request

The following example shows a request.

POST https://graph.microsoft.com/v1.0/me/events/{id}/forward
Content-type: application/json

{
  "ToRecipients":[
      {
        "EmailAddress": {
          "Address":"danas@contoso.com",
          "Name":"Dana Swope"
        }
      }
     ],
  "Comment": "Dana, hope you can make this meeting."
}

Response

The following example shows the response.

HTTP/1.1 202 Accepted