You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: "List of use cases that can be enabled using virtual events town hall APIs"
2
+
title: "Use cases for virtual events town hall Microsoft Graph APIs"
3
+
description: "Get a list of use cases that can be enabled via Microsoft Graph virtual events town hall APIs."
4
4
author: "awang119"
5
5
ms.localizationpriority: medium
6
6
ms.subservice: "cloud-communications"
7
7
ms.date: 11/18/2024
8
8
---
9
9
# Virtual events town hall API overview
10
+
10
11
Microsoft Graph virtual events town hall APIs allow you to get Teams town hall data and programmatically create, update, and cancel a Teams town hall.
11
12
12
-
To make the best use of the Graph virtual events town hall APIs, it’s helpful to understand the personas for the users who access the Teams town hall experience:
13
+
For you to make the best use of the Microsoft Graph virtual events town hall APIs, it’s helpful to understand the personas for the users who access the Teams town hall experience:
13
14
14
15
-**Organizers** are employees (in your organization) who manage the town hall. They're the authority on when town halls take place and who participates. They configure town hall details such as title, theme, attendee experience, and email rules.
15
16
-**Presenters** are employees (in your organization) or guests who lead the town hall.
16
17
-**Attendees** are either employees (in your organization) or guests who join the town hall and are either invited via email or the link to the town hall event is shared with them.
17
18
-**Teams tenant administrator** must authorize custom applications with appropriate permissions.
18
19
19
-
The following resource types can be used to build your town hall solution:
20
+
You can use the following resource types to build your town hall solution:
20
21
-[virtualEventTownhall](/graph/api/resources/virtualeventtownhall) – Used to create, get, update, publish, and cancel a Teams town hall.
21
22
-[virtualEventPresenter](/graph/api/resources/virtualeventpresenter) – Used to create, get, list, update, and delete a presenter for a Teams town hall.
22
23
-[virtualEventSession](/graph/api/resources/virtualeventsession) – A town hall created via Microsoft Graph APIs has one session that inherits the properties of online meetings.
@@ -27,21 +28,24 @@ The following table lists some solutions you can build by using the Teams client
27
28
| Solutions | Description |
28
29
| ------------- | ------------- |
29
30
|[Create/update/cancel](#createupdatecancel)| Programmatically create, update, and cancel Teams town hall.|
30
-
|[Data Sync](#data-sync)| Pull Teams town hall data in a custom application. |
31
-
|[Email communication](#email-communication)| Use your own email infrastructure to send out town hall-related notification emails. |
31
+
|[Data sync](#data-sync)| Pull Teams town hall data in a custom application. |
32
+
|[Email communication](#email-communication)| Use your own email infrastructure to send town hall-related notification emails. |
32
33
33
34
> [!NOTE]
34
-
>To build any Graph solutions, follow this guide on [how to register and give the right permissions to your application](/graph/auth/auth-concepts).
35
+
>To build any Microsoft Graph solutions, you need to register and give the right permissions to your application. For more information, see [Authentication and authorization basics](/graph/auth/auth-concepts).
35
36
36
37
### Create/update/cancel
37
-
- Use the [CREATE townhall API](/graph/api/virtualeventsroot-post-townhalls) to create a draft of the event, followed by the [PUBLISH townhall API](/graph/api/virtualeventtownhall-publish) to complete the creation and make it visible to its audience.
38
+
39
+
- Use the [Create townhall API](/graph/api/virtualeventsroot-post-townhalls) to create a draft of the event, followed by the [Publish townhall API](/graph/api/virtualeventtownhall-publish) to complete the creation and make it visible to its audience.
38
40
- The town hall created via Microsoft Graph APIs is a Teams town hall event that’s visible and editable in the Teams client.
39
-
- Just like in Teams, only the organizer can create, publish, and cancel town halls which is why the CREATE townhall API only supports delegated permissions on behalf of the organizer.
40
-
- Like in Teams, co-organizers can update town halls. So use the [UPDATE townhall API](/graph/api/virtualeventtownhall-update) with delegated permissions on behalf of the co-organizer.
41
+
- Just like in Teams, only the organizer can create, publish, and cancel town halls. The create townhall API only supports delegated permissions on behalf of the organizer.
42
+
- Like in Teams, co-organizers can update town halls. To update a town hall, use the [Update townhall API](/graph/api/virtualeventtownhall-update) with delegated permissions on behalf of the co-organizer.
41
43
42
-
### Data Sync
43
-
- Use the [GET townhall API](/graph/api/virtualeventtownhall-get) to pull data regarding a specific town hall, such as who is invited, who created the town hall, and who are the co-organizers.
44
-
-[List all the town halls in a tenant](/graph/api/virtualeventsroot-list-townhalls) with the granularity of where the user is an organizer or co-organizer -- supported in [delegated](/graph/api/virtualeventtownhall-getbyuserrole) and [application](/graph/api/virtualeventtownhall-getbyuseridandrole) permissions. These APIs are currently only available in Beta.
44
+
### Data sync
45
+
46
+
- Use the [Get townhall API](/graph/api/virtualeventtownhall-get) to pull data regarding a specific town hall, such as who is invited, who created the town hall, and who are the co-organizers.
47
+
-[List all the town halls in a tenant](/graph/api/virtualeventsroot-list-townhalls), including the town halls for which the user is an organizer or co-organizer. This scenario is supported for [delegated](/graph/api/virtualeventtownhall-getbyuserrole) and [application](/graph/api/virtualeventtownhall-getbyuseridandrole) permissions. Note that these APIs are currently only available in the beta endpoint.
45
48
46
49
### Email communication
47
-
- To turn off email communications to attendees, it needs to be done when [creating the town hall](/graph/api/virtualeventsroot-post-townhalls). In the `settings` property, set `isAttendeeEmailNotificationEnabled` to `false`. However, emails are still sent to organizers, co-organizers, and presenters (internal and external).
50
+
51
+
You can turn off email communications to attendees when you [create the town hall](/graph/api/virtualeventsroot-post-townhalls). In the **settings** property, set `isAttendeeEmailNotificationEnabled` to `false`.Note that emails are still sent to organizers, co-organizers, and presenters (internal and external).
0 commit comments