Skip to content

Commit 443b97b

Browse files
DanielabomDanielabom
authored
Merge pull request #25902 from microsoftgraph/bring-townhall-and-external-properties-to-GA
Bring Townhall and External Properties to GA
2 parents 5379895 + f6733de commit 443b97b

29 files changed

+920
-15
lines changed

‎api-reference/v1.0/api/virtualevent-setexternaleventinformation.md

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

‎api-reference/v1.0/api/virtualeventregistration-get.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,10 @@ Content-Type: application/json
123123
"firstName": "Emilee",
124124
"lastName": "Pham",
125125
"email": "EmileeMPham@contoso.com",
126+
"externalRegistrationInformation": {
127+
"referrer": "Facebook",
128+
"registrationId": "myExternalRegistrationId"
129+
},
126130
"status": "registered",
127131
"registrationDateTime": "2023-03-07T22:04:17",
128132
"cancelationDateTime": null,

‎api-reference/v1.0/api/virtualeventregistration-list.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,10 @@ Content-Type: application/json
124124
"firstName": "Emilee",
125125
"lastName": "Pham",
126126
"email": "EmileeMPham@contoso.com",
127+
"externalRegistrationInformation": {
128+
"referrer": "Facebook",
129+
"registrationId": "myExternalRegistrationId"
130+
},
127131
"status": "registered",
128132
"registrationDateTime": "2023-03-07T22:04:17",
129133
"cancelationDateTime": null,

‎api-reference/v1.0/api/virtualeventsroot-list-townhalls.md

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
---
2+
title: "List townhalls"
3+
description: "Get the list of all virtualEventTownhall objects created in a tenant."
4+
author: "halleclottey-msft"
5+
ms.localizationpriority: medium
6+
ms.subservice: "cloud-communications"
7+
doc_type: apiPageType
8+
ms.date: 12/09/2024
9+
---
10+
11+
# List townhalls
12+
13+
Namespace: microsoft.graph
14+
15+
Get the list of all [virtualEventTownhall](../resources/virtualeventtownhall.md) objects created in a tenant.
16+
17+
[!INCLUDE [national-cloud-support](../../includes/global-only.md)]
18+
19+
## Permissions
20+
21+
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).
22+
23+
<!-- { "blockType": "permissions", "name": "virtualeventsroot_list_townhalls" } -->
24+
[!INCLUDE [permissions-table](../includes/permissions/virtualeventsroot-list-townhalls-permissions.md)]
25+
26+
> [!NOTE]
27+
>
28+
> This API returns only **virtualEventTownhall** objects where the organizer is assigned an [application access policy](/graph/cloud-communication-online-meeting-application-access-policy).
29+
30+
## HTTP request
31+
32+
<!-- {
33+
"blockType": "ignored"
34+
}
35+
-->
36+
37+
``` http
38+
GET /solutions/virtualEvents/townhalls
39+
```
40+
41+
## Optional query parameters
42+
43+
This method supports the `$count` [OData query parameter](/graph/query-parameters) to help customize the response. If you use `?$count=true` in the request URL, the response contains a root-level property that denotes the total number of the resource; for example, `"@odata.count": 6`.
44+
45+
## Request headers
46+
47+
|Name|Description|
48+
|:---|:---|
49+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
50+
51+
## Request body
52+
53+
Don't supply a request body for this method.
54+
55+
## Response
56+
57+
If successful, this method returns a `200 OK` response code and a collection of [virtualEventTownhall](../resources/virtualeventtownhall.md) objects in the response body.
58+
59+
## Examples
60+
61+
### Request
62+
63+
The following example shows a request.
64+
65+
``` http
66+
GET https://graph.microsoft.com/beta/solutions/virtualEvents/townhalls
67+
```
68+
69+
### Response
70+
71+
The following example shows the response.
72+
>**Note:** The response object shown here might be shortened for readability.
73+
<!-- {
74+
"blockType": "response",
75+
"truncated": true,
76+
"@odata.type": "Collection(microsoft.graph.virtualEventTownhall)"
77+
}
78+
-->
79+
``` http
80+
HTTP/1.1 200 OK
81+
Content-Type: application/json
82+
83+
{
84+
"value": [
85+
{
86+
"@odata.type": "#microsoft.graph.virtualEventTownhall",
87+
"id": "fc6e8c15-2fd7-1dd5-caa0-87056e6a12be",
88+
"status": "published",
89+
"displayName": "The Impact of Tech on Our Lives",
90+
"description": {
91+
"content": "<p>Discusses how technology has changed the way we communicate, work, and interact with each other.</p>",
92+
"contentType": "html"
93+
},
94+
"startDateTime": {
95+
"dateTime": "2023-11-30T16:30:00",
96+
"timeZone": "Eastern Standard Time"
97+
},
98+
"endDateTime": {
99+
"dateTime": "2023-11-30T17:00:00",
100+
"timeZone": "Eastern Standard Time"
101+
},
102+
"createdBy": {
103+
"@odata.type": "microsoft.graph.communicationsIdentitySet",
104+
"application": null,
105+
"device": null,
106+
"user": {
107+
"@odata.type": "#microsoft.graph.communicationsUserIdentity",
108+
"id": "b7ef013a-c73c-4ec7-8ccb-e56290f45f68",
109+
"displayName": "Diane Demoss",
110+
"tenantId": "77229959-e479-4a73-b6e0-ddac27be315c"
111+
}
112+
},
113+
"audience": "everyone",
114+
"coOrganizers": [
115+
{
116+
"id": "7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b",
117+
"displayName": "Kenneth Brown",
118+
"tenantId": "77229959-e479-4a73-b6e0-ddac27be315c"
119+
}
120+
],
121+
"invitedAttendees": [
122+
{
123+
"@odata.type": "microsoft.graph.communicationsUserIdentity",
124+
"id": "127962bb-84e1-7b62-fd98-1c9d39def7b6",
125+
"displayName": "Emilee Pham",
126+
"tenantId": "77229959-e479-4a73-b6e0-ddac27be315c"
127+
}
128+
],
129+
"settings": {
130+
"isAttendeeEmailNotificationEnabled": false
131+
},
132+
"isInviteOnly": false,
133+
"externalEventInformation": [
134+
{
135+
"applicationId" : "1b7ba4d1-c377-4b2f-ad0e-a3fc50bc987b",
136+
"externalEventId": "myExternalEventId"
137+
}
138+
]
139+
}
140+
]
141+
}
142+
```

‎api-reference/v1.0/api/virtualeventsroot-list-webinars.md

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

‎api-reference/v1.0/api/virtualeventsroot-post-townhalls.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,7 @@ Content-Type: application/json
171171
"isAttendeeEmailNotificationEnabled": false
172172
},
173173
"invitedAttendees": [],
174-
"isInviteOnly": false
174+
"isInviteOnly": false,
175+
"externalEventInformation": []
175176
}
176177
```

‎api-reference/v1.0/api/virtualeventsroot-post-webinars.md

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

‎api-reference/v1.0/api/virtualeventtownhall-get.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,12 @@ Content-Type: application/json
170170
"tenantId": "77229959-e479-4a73-b6e0-ddac27be315c"
171171
}
172172
],
173-
"isInviteOnly": false
173+
"isInviteOnly": false,
174+
"externalEventInformation": [
175+
{
176+
"applicationId" : "1b7ba4d1-c377-4b2f-ad0e-a3fc50bc987b",
177+
"externalEventId": "myExternalEventId"
178+
}
179+
]
174180
}
175181
```

0 commit comments

Comments
 (0)