Update virtualAppointment (deprecated)

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.

Caution

The virtualAppointment resource and supporting methods are deprecated and will stop returning data on June 30, 2023. We recommend that you update existing apps that use this API to use the new Get join link function.

Update the properties of a virtualAppointment object.

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.

Note

Virtual appointment will transition from online meeting permissions to more specific virtual appointment permissions during the preview period. This will give developers more granular control over virtual appointment permissions. We'll provide additional details on when online meeting permissions will no longer be supported before the preview period ends.

HTTP request

PATCH /me/onlineMeetings/{onlineMeetingId}/virtualAppointment
PATCH /users/{userId}/onlineMeetings/{onlineMeetingId}/virtualAppointment

Request headers

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

Request body

In the request body, supply only the values for properties that should be updated. Existing properties that aren't included in the request body maintains their previous values or be recalculated based on changes to other property values.

The following table specifies the properties that can be updated.

Property Type Description
appointmentClients virtualAppointmentUser collection The client information for the virtual appointment, including name, email, and SMS phone number. Optional.
appointmentClientJoinWebUrl String The join web URL of the virtual appointment for clients with waiting room and browser join. Optional.
externalAppointmentId String The identifier of the appointment from the scheduling system, associated with the current virtual appointment. Optional.
externalAppointmentUrl String The URL of the appointment resource from the scheduling system, associated with the current virtual appointment. Optional.
settings virtualAppointmentSettings The settings associated with the virtual appointment resource. Optional.

Response

If successful, this method returns a 204 No Content response code.

Examples

Request

The following is an example of a request.

PATCH https://graph.microsoft.com/beta/me/onlineMeetings/MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZi/virtualAppointment 
Content-Type: application/json
If-Match: W/"ZfYdV7Meckeip07P//nwjAAADyI7NQ=="
Content-length: 379

{
    "@odata.type": "#microsoft.graph.virtualAppointment",
    "id": "0c7fda79-ff00-f57f-37e3-28183b6d09b5",
    "settings": {
        "@odata.type": "microsoft.graph.virtualAppointmentSettings",
        "allowClientToJoinUsingBrowser": "true"
    },
    "appointmentClients": [
        {
            "@odata.type": "microsoft.graph.virtualAppointmentUser",
            "emailAddress": "gradya@contoso.com",
            "displayName": "Grady Archie",
            "smsCapablePhoneNumber": "123-456-7890"
        }
    ],
    "externalAppointmentId": "AAMkADKnAAA=",
    "externalAppointmentUrl": "https://anyschedulingsystem.com/api/appointments/MkADKnAAA=",
    "appointmentClientJoinWebUrl": "https://visit.teams.microsoft.com/webrtc-svc/api/route?tid=a796be92-&convId=19:meeting_=True"
}

Response

The following example shows the response.

HTTP/1.1 204 No Content

PATCH returns 412 Precondition Failed if the "If-Match" value doesn't match "ETag" in the virtual appointment.