virtualEvent: setExternalEventInformation
Namespace: microsoft.graph
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Link external event information to a virtualEventTownhall or virtualEventWebinar by setting an externalEventId.
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 permission | Higher privileged permissions |
|---|---|---|
| Delegated (work or school account) | VirtualEvent.ReadWrite | Not available. |
| Delegated (personal Microsoft account) | Not supported. | Not supported. |
| Application | Not supported. | Not supported. |
HTTP request
To link external town hall event information to a town hall event:
POST /solutions/virtualEvents/townhalls/{id}/setExternalEventInformation
To link external webinar event information to a webinar event:
POST /solutions/virtualEvents/webinars/{id}/setExternalEventInformation
Request headers
| Name | Description |
|---|---|
| Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Request body
In the request body, supply a JSON representation of the externalEventId property of the virtualEventExternalInformation object.
You can specify the following property when you create the virtualEventExternalInformation.
| Property | Type | Description |
|---|---|---|
| externalEventId | String | The identifier for a virtualEventExternalInformation object. Optional. If set, the maximum supported length is 256 characters. |
Response
If successful, this method returns a 204 No Content response code.
Examples
Example 1: Link external town hall event information to a town hall event
The following example shows how to link external town hall event information to a town hall event by setting an externalEventId.
Request
The following example shows a request.
POST https://graph.microsoft.com/beta/solutions/virtualEvents/townhalls/a57082a9-7629-4f74-8da0-8d621aab4d2d@4aa05bcc-1cac-4a83-a9ae-0db84b88f4ba/setExternalEventInformation
Content-Type: application/json
{
"externalEventId": "myExternalEventId"
}
Response
The following example shows the response.
HTTP/1.1 204 No Content
Example 2: Link external webinar event information to a webinar event
The following example shows how to link external webinar event information to a webinar event by setting an externalEventId.
Request
The following example shows a request.
POST https://graph.microsoft.com/beta/solutions/virtualEvents/webinars/a57082a9-7629-4f74-8da0-8d621aab4d2d@4aa05bcc-1cac-4a83-a9ae-0db84b88f4ba/setExternalEventInformation
Content-Type: application/json
{
"externalEventId": "myExternalEventId"
}
Response
The following example shows the response.
HTTP/1.1 204 No Content