Skip to content

Commit 5b7739d

Browse files
LauragraLauragra
authored
Merge pull request #25459 from microsoftgraph/add-external-event-id
Add external event properties
2 parents 9bc0e75 + a662d07 commit 5b7739d

22 files changed

+353
-11
lines changed

‎api-reference/beta/api/virtualevent-setexternaleventinformation.md

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
---
2+
title: "virtualEvent: setExternalEventInformation"
3+
description: "Link external event information to a town hall or webinar event by setting an externalEventId."
4+
author: "halleclottey-msft"
5+
ms.localizationpriority: medium
6+
ms.subservice: "cloud-communications"
7+
doc_type: apiPageType
8+
---
9+
10+
# virtualEvent: setExternalEventInformation
11+
12+
Namespace: microsoft.graph
13+
14+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
15+
16+
Link external event information to a [virtualEventTownhall](../resources/virtualeventtownhall.md) or [virtualEventWebinar](../resources/virtualeventwebinar.md) by setting an **externalEventId**.
17+
18+
## Permissions
19+
20+
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](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
21+
22+
<!-- {
23+
"blockType": "permissions",
24+
"name": "virtualevent-setexternaleventinformation-permissions"
25+
}
26+
-->
27+
[!INCLUDE [permissions-table](../includes/permissions/virtualevent-setexternaleventinformation-permissions.md)]
28+
29+
## HTTP request
30+
31+
To link external town hall event information to a town hall event:
32+
33+
<!-- {
34+
"blockType": "ignored"
35+
}
36+
-->
37+
``` http
38+
POST /solutions/virtualEvents/townhalls/{id}/setExternalEventInformation
39+
```
40+
41+
To link external webinar event information to a webinar event:
42+
43+
<!-- {
44+
"blockType": "ignored"
45+
}
46+
-->
47+
``` http
48+
POST /solutions/virtualEvents/webinars/{id}/setExternalEventInformation
49+
```
50+
51+
## Request headers
52+
53+
|Name|Description|
54+
|:---|:---|
55+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
56+
57+
## Request body
58+
59+
In the request body, supply a JSON representation of the **externalEventId** property of the [virtualEventExternalInformation](../resources/virtualeventexternalinformation.md) object.
60+
61+
You can specify the following property when you create the [virtualEventExternalInformation](../resources/virtualeventexternalinformation.md).
62+
63+
|Property|Type|Description|
64+
|:---|:---|:---|
65+
| externalEventId | String | The identifier for a **virtualEventExternalInformation** object. Optional. If set, the maximum supported length is 256 characters. |
66+
67+
## Response
68+
69+
If successful, this method returns a `204 No Content` response code.
70+
71+
## Examples
72+
73+
### Example 1: Link external town hall event information to a town hall event
74+
75+
The following example shows how to link external town hall event information to a town hall event by setting an **externalEventId**.
76+
77+
#### Request
78+
79+
The following example shows a request.
80+
81+
<!-- {
82+
"blockType": "request",
83+
"name": "virtualeventtownhall.setexternaleventinformation",
84+
"sampleKeys": ["a57082a9-7629-4f74-8da0-8d621aab4d2d@4aa05bcc-1cac-4a83-a9ae-0db84b88f4ba"]
85+
}
86+
-->
87+
``` http
88+
POST https://graph.microsoft.com/beta/solutions/virtualEvents/townhalls/a57082a9-7629-4f74-8da0-8d621aab4d2d@4aa05bcc-1cac-4a83-a9ae-0db84b88f4ba/setExternalEventInformation
89+
Content-Type: application/json
90+
91+
{
92+
"externalEventId": "myExternalEventId"
93+
}
94+
```
95+
96+
#### Response
97+
98+
The following example shows the response.
99+
100+
<!-- {
101+
"blockType": "response",
102+
"truncated": true
103+
}
104+
-->
105+
``` http
106+
HTTP/1.1 204 No Content
107+
```
108+
109+
### Example 2: Link external webinar event information to a webinar event
110+
111+
The following example shows how to link external webinar event information to a webinar event by setting an **externalEventId**.
112+
113+
#### Request
114+
115+
The following example shows a request.
116+
117+
<!-- {
118+
"blockType": "request",
119+
"name": "virtualeventwebinar.setexternaleventinformation",
120+
"sampleKeys": ["a57082a9-7629-4f74-8da0-8d621aab4d2d@4aa05bcc-1cac-4a83-a9ae-0db84b88f4ba"]
121+
}
122+
-->
123+
``` http
124+
POST https://graph.microsoft.com/beta/solutions/virtualEvents/webinars/a57082a9-7629-4f74-8da0-8d621aab4d2d@4aa05bcc-1cac-4a83-a9ae-0db84b88f4ba/setExternalEventInformation
125+
Content-Type: application/json
126+
127+
{
128+
"externalEventId": "myExternalEventId"
129+
}
130+
```
131+
132+
#### Response
133+
134+
The following example shows the response.
135+
136+
<!-- {
137+
"blockType": "response",
138+
"truncated": true
139+
}
140+
-->
141+
``` http
142+
HTTP/1.1 204 No Content
143+
```

‎api-reference/beta/api/virtualeventsroot-list-townhalls.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,13 @@ Content-Type: application/json
130130
"settings": {
131131
"isAttendeeEmailNotificationEnabled": false
132132
},
133-
"isInviteOnly": false
133+
"isInviteOnly": false,
134+
"externalEventInformation": [
135+
{
136+
"applicationId" : "1b7ba4d1-c377-4b2f-ad0e-a3fc50bc987b",
137+
"externalEventId": "myExternalEventId"
138+
}
139+
]
134140
}
135141
]
136142
}

‎api-reference/beta/api/virtualeventsroot-list-webinars.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,13 @@ Content-Type: application/json
160160
],
161161
"settings": {
162162
"isAttendeeEmailNotificationEnabled": false
163-
}
163+
},
164+
"externalEventInformation": [
165+
{
166+
"applicationId" : "67a527ba-ef0e-4ba2-88b6-4fa5e9711757",
167+
"externalEventId": "myExternalEventId"
168+
}
169+
]
164170
}
165171
]
166172
}

‎api-reference/beta/api/virtualeventsroot-post-townhalls.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,7 @@ Content-Type: application/json
170170
"settings": {
171171
"isAttendeeEmailNotificationEnabled": false
172172
},
173-
"isInviteOnly": false
173+
"isInviteOnly": false,
174+
"externalEventInformation": []
174175
}
175176
```

‎api-reference/beta/api/virtualeventsroot-post-webinars.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,7 @@ Content-Type: application/json
167167
],
168168
"settings": {
169169
"isAttendeeEmailNotificationEnabled": false
170-
}
170+
},
171+
"externalEventInformation": []
171172
}
172173
```

‎api-reference/beta/api/virtualeventtownhall-get.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,12 @@ Content-Type: application/json
166166
"settings": {
167167
"isAttendeeEmailNotificationEnabled": false
168168
},
169-
"isInviteOnly": false
169+
"isInviteOnly": false,
170+
"externalEventInformation": [
171+
{
172+
"applicationId" : "1b7ba4d1-c377-4b2f-ad0e-a3fc50bc987b",
173+
"externalEventId": "myExternalEventId"
174+
}
175+
]
170176
}
171177
```

‎api-reference/beta/api/virtualeventtownhall-getbyuseridandrole.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,13 @@ Content-Type: application/json
163163
],
164164
"settings": {
165165
"isAttendeeEmailNotificationEnabled": false
166-
}
166+
},
167+
"externalEventInformation": [
168+
{
169+
"applicationId" : "1b7ba4d1-c377-4b2f-ad0e-a3fc50bc987b",
170+
"externalEventId": "myExternalEventId"
171+
}
172+
]
167173
}
168174
]
169175
}

‎api-reference/beta/api/virtualeventtownhall-getbyuserrole.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,13 @@ Content-Type: application/json
160160
],
161161
"settings": {
162162
"isAttendeeEmailNotificationEnabled": false
163-
}
163+
},
164+
"externalEventInformation": [
165+
{
166+
"applicationId" : "1b7ba4d1-c377-4b2f-ad0e-a3fc50bc987b",
167+
"externalEventId": "myExternalEventId"
168+
}
169+
]
164170
}
165171
]
166172
}

‎api-reference/beta/api/virtualeventtownhall-update.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,12 @@ Content-Type: application/json
182182
"displayName": "Emilee Pham",
183183
"tenantId": "77229959-e479-4a73-b6e0-ddac27be315c"
184184
}
185+
],
186+
"externalEventInformation": [
187+
{
188+
"applicationId" : "1b7ba4d1-c377-4b2f-ad0e-a3fc50bc987b",
189+
"externalEventId": "myExternalEventId"
190+
}
185191
]
186192
}
187193
```

‎api-reference/beta/api/virtualeventwebinar-get.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,13 @@ Content-Type: application/json
157157
],
158158
"settings": {
159159
"isAttendeeEmailNotificationEnabled": false
160-
}
160+
},
161+
"externalEventInformation": [
162+
{
163+
"applicationId" : "67a527ba-ef0e-4ba2-88b6-4fa5e9711757",
164+
"externalEventId": "myExternalEventId"
165+
}
166+
]
161167
}
162168
}
163169
```

0 commit comments

Comments
 (0)