Create virtualEventPresenter

2024-08-02

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.

Create a new virtualEventPresenter object on a virtual event.

Currently the supported virtual event types are: virtualEventTownhall, virtualEventWebinar.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	❌	❌	❌

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 permissions	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

POST /solutions/virtualEvents/townhalls/{townhallId}/presenters
POST /solutions/virtualEvents/webinars/{webinarId}/presenters

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type	application/json. Required.

Request body

In the request body, supply a JSON representation of the virtualEventPresenter object.

You can specify the following properties when you create a presenter on a virtualEventTownhall:

Property	Type	Description
identity	identity	Identity information of the presenter. The supported identities are: communicationsGuestIdentity and communicationsUserIdentity.

You can specify the following properties when you create a presenter on a virtualEventWebinar:

Property	Type	Description
identity	identity	Identity information of the presenter. The supported identities are: communicationsGuestIdentity and communicationsUserIdentity.
presenterDetails	virtualEventPresenterDetails	Other detail information of the presenter.

Response

If successful, this method returns a 201 Created response code and a virtualEventPresenter object in the response body.

Examples

Example 1: Create an in-tenant presenter

The following example shows how to create an internal user as a presenter on a virtualEventTownhall.

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/solutions/virtualEvents/townhalls/502dadea-b5d8-44aa-a851-a0ac496a36bf@09a21d49-f0f3-4b3f-96b6-f381e9430742/presenters
Content-Type: application/json

{
  "identity": {
    "@odata.type": "#microsoft.graph.communicationsUserIdentity",
    "id": "7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b"
  }
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new VirtualEventPresenter
{
	Identity = new CommunicationsUserIdentity
	{
		OdataType = "#microsoft.graph.communicationsUserIdentity",
		Id = "7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b",
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Solutions.VirtualEvents.Townhalls["{virtualEventTownhall-id}"].Presenters.PostAsync(requestBody);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

requestBody := graphmodels.NewVirtualEventPresenter()
identity := graphmodels.NewCommunicationsUserIdentity()
id := "7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b"
identity.SetId(&id) 
requestBody.SetIdentity(identity)

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
presenters, err := graphClient.Solutions().VirtualEvents().Townhalls().ByVirtualEventTownhallId("virtualEventTownhall-id").Presenters().Post(context.Background(), requestBody, nil)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

VirtualEventPresenter virtualEventPresenter = new VirtualEventPresenter();
CommunicationsUserIdentity identity = new CommunicationsUserIdentity();
identity.setOdataType("#microsoft.graph.communicationsUserIdentity");
identity.setId("7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b");
virtualEventPresenter.setIdentity(identity);
VirtualEventPresenter result = graphClient.solutions().virtualEvents().townhalls().byVirtualEventTownhallId("{virtualEventTownhall-id}").presenters().post(virtualEventPresenter);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


const options = {
	authProvider,
};

const client = Client.init(options);

const virtualEventPresenter = {
  identity: {
    '@odata.type': '#microsoft.graph.communicationsUserIdentity',
    id: '7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b'
  }
};

await client.api('/solutions/virtualEvents/townhalls/502dadea-b5d8-44aa-a851-a0ac496a36bf@09a21d49-f0f3-4b3f-96b6-f381e9430742/presenters')
	.version('beta')
	.post(virtualEventPresenter);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\VirtualEventPresenter;
use Microsoft\Graph\Beta\Generated\Models\CommunicationsUserIdentity;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new VirtualEventPresenter();
$identity = new CommunicationsUserIdentity();
$identity->setOdataType('#microsoft.graph.communicationsUserIdentity');
$identity->setId('7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b');
$requestBody->setIdentity($identity);

$result = $graphServiceClient->solutions()->virtualEvents()->townhalls()->byVirtualEventTownhallId('virtualEventTownhall-id')->presenters()->post($requestBody)->wait();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


Import-Module Microsoft.Graph.Beta.Bookings

$params = @{
	identity = @{
		"@odata.type" = "#microsoft.graph.communicationsUserIdentity"
		id = "7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b"
	}
}

New-MgBetaVirtualEventTownhallPresenter -VirtualEventTownhallId $virtualEventTownhallId -BodyParameter $params

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.virtual_event_presenter import VirtualEventPresenter
from msgraph_beta.generated.models.communications_user_identity import CommunicationsUserIdentity
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = VirtualEventPresenter(
	identity = CommunicationsUserIdentity(
		odata_type = "#microsoft.graph.communicationsUserIdentity",
		id = "7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b",
	),
)

result = await graph_client.solutions.virtual_events.townhalls.by_virtual_event_townhall_id('virtualEventTownhall-id').presenters.post(request_body)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "id": "7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b",
  "email": "kenneth.brown@contoso.com",
  "identity": {
    "@odata.type": "#microsoft.graph.communicationsUserIdentity",
    "id": "7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b",
    "displayName": "Kennth Brown",
    "tenantId": "77229959-e479-4a73-b6e0-ddac27be315c"
  },
  "presenterDetails": null
}

Example 2: Create an out-of-tenant presenter

The following example shows how to create a guest user as a presenter on a virtualEventTownhall.

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/solutions/virtualEvents/townhalls/502dadea-b5d8-44aa-a851-a0ac496a36bf@09a21d49-f0f3-4b3f-96b6-f381e9430742/presenters
Content-Type: application/json

{
  "identity": {
    "@odata.type": "#microsoft.graph.communicationsGuestIdentity",
    "displayName": "Guest Speaker",
    "email": "guest.speaker@fabrikam.com"
  }
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new VirtualEventPresenter
{
	Identity = new CommunicationsGuestIdentity
	{
		OdataType = "#microsoft.graph.communicationsGuestIdentity",
		DisplayName = "Guest Speaker",
		Email = "guest.speaker@fabrikam.com",
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Solutions.VirtualEvents.Townhalls["{virtualEventTownhall-id}"].Presenters.PostAsync(requestBody);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

requestBody := graphmodels.NewVirtualEventPresenter()
identity := graphmodels.NewCommunicationsGuestIdentity()
displayName := "Guest Speaker"
identity.SetDisplayName(&displayName) 
email := "guest.speaker@fabrikam.com"
identity.SetEmail(&email) 
requestBody.SetIdentity(identity)

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
presenters, err := graphClient.Solutions().VirtualEvents().Townhalls().ByVirtualEventTownhallId("virtualEventTownhall-id").Presenters().Post(context.Background(), requestBody, nil)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

VirtualEventPresenter virtualEventPresenter = new VirtualEventPresenter();
CommunicationsGuestIdentity identity = new CommunicationsGuestIdentity();
identity.setOdataType("#microsoft.graph.communicationsGuestIdentity");
identity.setDisplayName("Guest Speaker");
identity.setEmail("guest.speaker@fabrikam.com");
virtualEventPresenter.setIdentity(identity);
VirtualEventPresenter result = graphClient.solutions().virtualEvents().townhalls().byVirtualEventTownhallId("{virtualEventTownhall-id}").presenters().post(virtualEventPresenter);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


const options = {
	authProvider,
};

const client = Client.init(options);

const virtualEventPresenter = {
  identity: {
    '@odata.type': '#microsoft.graph.communicationsGuestIdentity',
    displayName: 'Guest Speaker',
    email: 'guest.speaker@fabrikam.com'
  }
};

await client.api('/solutions/virtualEvents/townhalls/502dadea-b5d8-44aa-a851-a0ac496a36bf@09a21d49-f0f3-4b3f-96b6-f381e9430742/presenters')
	.version('beta')
	.post(virtualEventPresenter);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\VirtualEventPresenter;
use Microsoft\Graph\Beta\Generated\Models\CommunicationsGuestIdentity;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new VirtualEventPresenter();
$identity = new CommunicationsGuestIdentity();
$identity->setOdataType('#microsoft.graph.communicationsGuestIdentity');
$identity->setDisplayName('Guest Speaker');
$identity->setEmail('guest.speaker@fabrikam.com');
$requestBody->setIdentity($identity);

$result = $graphServiceClient->solutions()->virtualEvents()->townhalls()->byVirtualEventTownhallId('virtualEventTownhall-id')->presenters()->post($requestBody)->wait();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


Import-Module Microsoft.Graph.Beta.Bookings

$params = @{
	identity = @{
		"@odata.type" = "#microsoft.graph.communicationsGuestIdentity"
		displayName = "Guest Speaker"
		email = "guest.speaker@fabrikam.com"
	}
}

New-MgBetaVirtualEventTownhallPresenter -VirtualEventTownhallId $virtualEventTownhallId -BodyParameter $params

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.virtual_event_presenter import VirtualEventPresenter
from msgraph_beta.generated.models.communications_guest_identity import CommunicationsGuestIdentity
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = VirtualEventPresenter(
	identity = CommunicationsGuestIdentity(
		odata_type = "#microsoft.graph.communicationsGuestIdentity",
		display_name = "Guest Speaker",
		email = "guest.speaker@fabrikam.com",
	),
)

result = await graph_client.solutions.virtual_events.townhalls.by_virtual_event_townhall_id('virtualEventTownhall-id').presenters.post(request_body)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "id": "184975c0-4096-4a02-b251-c48546691c42",
  "email": "guest.speaker@fabrikam.com",
  "presenterDetails": null,
  "identity": {
    "@odata.type": "#microsoft.graph.communicationsGuestIdentity",
    "id": "184975c0-4096-4a02-b251-c48546691c42",
    "displayName": "Guest Speaker",
    "email": "guest.speaker@fabrikam.com"
  }
}

Share via

Create virtualEventPresenter

Permissions

HTTP request

Request headers

Request body

Response

Examples

Example 1: Create an in-tenant presenter

Request

Response

Example 2: Create an out-of-tenant presenter

Request

Response

Feedback

Additional resources