Update onlineMeeting
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.
Update the properties of the specified onlineMeeting object.
Please see Request body section for the list of properties that support updating.
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) | OnlineMeetings.ReadWrite | Not available. |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | Not supported. | Not supported. |
To use application permission for this API, tenant administrators must create an application access policy and grant it to a user to authorize the app configured in the policy to update online meetings on behalf of that user (with user ID specified in the request path).
HTTP request
To update the specified onlineMeeting using meeting ID with delegated (/me
) and app (/users/{userId}/
) permission:
PATCH /me/onlineMeetings/{meetingId}
PATCH /users/{userId}/onlineMeetings/{meetingId}
Note
- userId is the object ID of a user in Microsoft Entra admin center > user management page. For more details, see application access policy.
meetingId
is the id of an onlineMeeting object.
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Content-type | application/json. Required. |
Request body
The following table lists the properties that can be updated. In the request body, include only the properties that need updating, with the following exceptions:
- Updating the start or end date/time of an online meeting always requires both startDateTime and endDateTime properties in the request body.
- The organizer field of the participants property cannot be updated. The organizer of the meeting cannot be modified after the meeting is created.
- Updating the attendees field of the participants property, such as adding or removing an attendee to the meeting, always requires the full list of attendees in the request body.
The last column indicates whether updating this property will take effect for an in-progress meeting.
Property | Type | Description | Applies to in-progress meetings? |
---|---|---|---|
startDateTime | DateTime | The meeting start time in UTC. | No |
endDateTime | DateTime | The meeting end time in UTC. | No |
subject | String | The subject of the online meeting. | No |
participants | meetingParticipants | The participants associated with the online meeting. Only attendees can be updated. | No |
isEntryExitAnnounced | Boolean | Whether or not to announce when callers join or leave. | Yes |
lobbyBypassSettings | lobbyBypassSettings | Specifies which participants can bypass the meeting lobby. | Yes |
allowedPresenters | onlineMeetingPresenters | Specifies who can be a presenter in a meeting. | Yes |
allowAttendeeToEnableCamera | Boolean | Indicates whether attendees can turn on their camera. | Yes |
allowAttendeeToEnableMic | Boolean | Indicates whether attendees can turn on their microphone. | Yes |
allowMeetingChat | meetingChatMode | Specifies the mode of meeting chat. | Yes |
allowTeamworkReactions | Boolean | Indicates whether Teams reactions are enabled for the meeting. | Yes |
recordAutomatically | Boolean | Indicates whether to record the meeting automatically. | No |
Note
- For the list of possible values for allowedPresenters and allowMeetingChat, see onlineMeeting.
- When updating the value of allowedPresenters to
roleIsPresenter
, include a full list of attendees with specified attendees' role set topresenter
in the request body.
Response
If successful, this method returns a 200 OK
response code and an updated onlineMeeting object in the response body.
Examples
Example 1: Update the startDateTime, endDateTime and subject
Request
Note: The meeting ID has been shortened for readability.
PATCH https://graph.microsoft.com/beta/me/onlineMeetings/MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZi
Content-Type: application/json
{
"startDateTime": "2020-09-09T14:33:30.8546353-07:00",
"endDateTime": "2020-09-09T15:03:30.8566356-07:00",
"subject": "Patch Meeting Subject"
}
Response
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-Type: application/json
{
"id":"MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZi",
"creationDateTime":"2020-07-03T00:23:39.444642Z",
"startDateTime":"2020-09-09T21:33:30.8546353Z",
"endDateTime":"2020-09-09T22:03:30.8566356Z",
"joinWebUrl":"url",
"subject":"Patch Meeting Subject",
"isBroadcast":false,
"autoAdmittedUsers":"EveryoneInCompany",
"outerMeetingAutoAdmittedUsers":null,
"participants":{
"organizer":{
"upn":"upn",
"role": "presenter",
"identity":{
"azureApplicationInstance":null,
"applicationInstance":null,
"application":null,
"device":null,
"user":{
"id":"8716745d-77a9-4be3-afff-009e4b81658e",
"displayName":null,
"tenantId":"0823831b-1f1b-424b-b90a-1caa345a742a",
"identityProvider":"AAD"
}
}
}
},
"audioConferencing":{
"conferenceId":"id",
"tollNumber":"+1-900-555-0100",
"tollFreeNumber":"+1-800-555-0100",
"dialinUrl":"url"
}
}
Example 2: Update the lobbyBypassSettings
Note: The meeting ID has been shortened for readability.
PATCH https://graph.microsoft.com/beta/me/onlineMeetings/MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZi
Content-Type: application/json
{
"lobbyBypassSettings": {
"isDialInBypassEnabled": true
}
}
Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZi",
"creationDateTime":"2020-07-03T00:23:39.444642Z",
"startDateTime":"2020-09-09T21:33:30.8546353Z",
"endDateTime":"2020-09-09T22:03:30.8566356Z",
"joinWebUrl":"(redacted)",
"subject":"Patch Meeting Subject",
"autoAdmittedUsers": "EveryoneInCompany",
"isEntryExitAnnounced": true,
"allowedPresenters": "everyone",
"videoTeleconferenceId": "(redacted)",
"participants": {
"organizer": {
"upn": "(redacted)",
"role": "presenter",
"identity": {
"user": {
"id": "dc17674c-81d9-4adb-bfb2-8f6a442e4622",
"displayName": null,
"tenantId": "909c6581-5130-43e9-88f3-fcb3582cde38",
"identityProvider": "AAD"
}
}
},
"attendees": [],
},
"lobbyBypassSettings": {
"scope": "organization",
"isDialInBypassEnabled": true
}
}
Palaute
https://aka.ms/ContentUserFeedback.
Tulossa pian: Vuoden 2024 aikana poistamme asteittain GitHub Issuesin käytöstä sisällön palautemekanismina ja korvaamme sen uudella palautejärjestelmällä. Lisätietoja on täällä:Lähetä ja näytä palaute kohteelle