Participants - Update

Service:

Communication

API Version:

2023-10-30-preview

Update participants in a room.

PATCH {endpoint}/rooms/{roomId}/participants?api-version=2023-10-30-preview

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string url	The endpoint of the Azure Communication resource.
roomId	path	True	string	The id of the room to update the participants in.
api-version	query	True	string	Version of API to invoke.

Request Header

Media Types: "application/merge-patch+json"

Name	Required	Type	Description
Authorization	True	string	An authentication string containing a signature generated using HMAC-SHA256 scheme.

Request Body

Media Types: "application/merge-patch+json"

Name	Type	Description
participants	<string,  ParticipantProperties>	Participants to be updated.

Responses

Name	Type	Description
200 OK	object	The participants were successfully updated.
Other Status Codes	CommunicationErrorResponse	Error response Headers x-ms-error-code: string

Security

Authorization

An authentication string containing a signature generated using HMAC-SHA256 scheme.

Type: apiKey
In: header

Examples

Update participants

Sample Request

HTTP

PATCH https://contoso.communication.azure.com//rooms/99199690362660524/participants?api-version=2023-10-30-preview

{
  "participants": {
    "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000666": {
      "role": "Attendee"
    },
    "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000777": {
      "role": "Presenter"
    },
    "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000888": null
  }
}

Sample Response

Status code:

200

{}

Definitions

Name	Description
ParticipantProperties
Role	The role of a room participant. The default value is Attendee.
UpdateParticipantsRequest	Participants to be updated in the room.

ParticipantProperties

Name	Type	Description
role	Role	The role of a room participant. The default value is Attendee.

Role

The role of a room participant. The default value is Attendee.

Name	Type	Description
Attendee	string
Consumer	string
Presenter	string

UpdateParticipantsRequest

Participants to be updated in the room.

Name	Type	Description
participants	<string,  ParticipantProperties>	Participants to be updated.