Microsoft Graph town hall APIs now available in beta

Annie Wang

Microsoft Teams supports multiple types of scheduled real-time voice and video experiences, such as meetingswebinars, and town halls. With the retirement of Teams live events in favor of Teams Town hall, we’re announcing the preview (beta) release of new Microsoft Graph town hall APIs.

With town halls, customers can host various types of internal and external events, including company-wide town halls, all hands and global team meetings, internal broadcasts, fireside chats, and more. Town halls provide a one-to-many format with advanced production capabilities and a structured approach for attendee engagement.

The presenter view of a live Teams town hallThe presenter view of a live Teams town hall

The new Microsoft Graph town hall APIs enable you to support the following personas in your app:

  • Organizers are employees (in your organization) who manage the town hall. They are 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.
  • Presenters are employees (in your organization) or external participants who lead the town hall.
  • Attendees who are either employees (in your organization) or external users who join the town hall via an email invitation with a join link or is shared the join link.

About the new APIs for Teams town halls

The following table lists the Microsoft Graph town hall API resources and methods.

Microsoft Graph resource Methods  
virtualEventTownhall
  • Create a town hall in draft mode.
  • Get information about the town hall.
  • Update the town hall information.
  • Cancel a town hall.
  • Publish the town hall to be available for its audience.
virtualEventPresenter
  • List presenters for the town hall.
  • Create a presenter (internal or external of your organization) for the town hall.
  • Get a presenter of a town hall’s information.
  • Delete the presenter from a town hall.
VirtualEventSession
  • List all the sessions in a town hall (currently, multisessions aren’t supported).
  • Get a specific session in a town hall.

These APIs enable you to do the following:

  • Automate town hall creation.
  • Develop a third-party solution for event management to manage town halls.
  • Transition from using the deprecated Teams live events APIs to using Town hall APIs.

The Microsoft Graph API structure for town halls is consistent with the information architecture in the Microsoft Teams user experience. This ensures that end users can seamlessly use both the built-in Teams UI and custom applications that use Microsoft Graph APIs.

The Teams built-in experience for creating a town hall, which can also be done programmatically by using Microsoft Graph town hall APIsThe Teams built-in experience for creating a town hall, which can also be done programmatically by using Microsoft Graph town hall APIs

For more information and to get started with these APIs, see the virtualEventTownhall documentation. For feedback on the beta APIs, post in the Feedback portal.

Happy coding!

Follow us on X (Twitter) / @Microsoft365Dev, LinkedIn, and subscribe to our YouTube channel to stay up to date on the latest developer news and announcements.

0 comments

Leave a comment

Feedback usabilla icon