Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Namespace: microsoft.graph
Update the properties of a virtualEventTownhall object.
Only the Organizer and Co-organizer can make changes to a townhall event.
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
PATCH /solutions/virtualEvents/townhalls/{id}
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 only the values for properties to update. Existing properties that aren't included in the request body maintain their previous values or are recalculated based on changes to other property values.
The following table specifies the properties that can be updated.
Property | Type | Description |
---|---|---|
coOrganizers | communicationsUserIdentity collection | Identity information of coorganizers of the virtual event. |
description | itemBody | Description of the virtual event. |
displayName | String | Display name of the virtual event. |
endDateTime | dateTimeTimeZone | Date and time when the virtual event ends. |
invitedAttendees | identity collection | The identities of the attendees invited to the town hall. The supported identities are: communicationsGuestIdentity and communicationsUserIdentity. |
settings | virtualEventSettings | The virtual event settings. |
startDateTime | dateTimeTimeZone | Date and time when the virtual event starts. |
Response
If successful, this method returns a 200 OK
response code and an updated virtualEventTownhall object in the response body.
Examples
Request
The following example shows a request.
PATCH https://graph.microsoft.com/v1.0/solutions/virtualEvents/townhalls/fc6e8c15-2fd7-1dd5-caa0-87056e6a12be
Content-Type: application/json
{
"startDateTime": {
"dateTime": "2024-03-31T10:00:00",
"timeZone": "Pacific Standard Time"
},
"endDateTime": {
"dateTime": "2024-03-31T17:00:00",
"timeZone": "Pacific Standard Time"
}
}
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.virtualEventTownhall",
"id": "a57082a9-7629-4f74-8da0-8d621aab4d2d@4aa05bcc-1cac-4a83-a9ae-0db84b88f4ba",
"status": "draft",
"displayName": "The Impact of Tech on Our Lives",
"description": {
"content": "<p>Discusses how technology has changed the way we communicate, work, and interact with each other.<p>",
"contentType": "html"
},
"startDateTime": {
"dateTime": "2024-03-31T10:00:00",
"timeZone": "Pacific Standard Time"
},
"endDateTime": {
"dateTime": "2024-03-31T17:00:00",
"timeZone": "Pacific Standard Time"
},
"createdBy": {
"application": null,
"device": null,
"user": {
"@odata.type": "#microsoft.graph.communicationsUserIdentity",
"id": "b7ef013a-c73c-4ec7-8ccb-e56290f45f68",
"displayName": "Diane Demoss",
"tenantId": "77229959-e479-4a73-b6e0-ddac27be315c"
}
},
"audience": "organization",
"isInviteOnly": false,
"coOrganizers": [
{
"id": "7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b",
"displayName": "Kenneth Brown",
"tenantId": "77229959-e479-4a73-b6e0-ddac27be315c"
}
],
"invitedAttendees": [
{
"@odata.type": "microsoft.graph.communicationsUserIdentity",
"id": "127962bb-84e1-7b62-fd98-1c9d39def7b6",
"displayName": "Emilee Pham",
"tenantId": "77229959-e479-4a73-b6e0-ddac27be315c"
}
],
"settings": {
"isAttendeeEmailNotificationEnabled": false
},
"externalEventInformation": [
{
"applicationId" : "1b7ba4d1-c377-4b2f-ad0e-a3fc50bc987b",
"externalEventId": "myExternalEventId"
}
]
}