Test Environment. You are currently using the Webex for Developers test environment. Apps created here will not be available for use with Webex Teams. Please visit Webex for Developers to manage your apps.

Update a Participant

To mute, unmute, expel, or admit a participant in a live meeting. The participantId is required to identify the meeting and the participant.

The attribute 'expel' always takes precedence over 'admit' and 'muted'. The request can have all 'expel', 'admit' and 'muted' or any of them.

PUT/v1/meetingParticipants/{participantId}
URI Parameters
participantId
stringrequired

The unique identifier for the meeting and the participant.

Body Parameters
muted
boolean

The value is true or false, and means to mute or unmute the audio of a participant.

admit
boolean

The value can be true or false. The value of true is to admit a participant to the meeting if the participant is in the lobby, No-Op if the participant is not in the lobby or when the value is set to false.

expel
boolean

The attribute is exclusive and its value can be true or false. The value of true means that the participant will be expelled from the meeting, the value of false means No-Op.

Response Properties
id
string

The participant id to uniquely identify the meeting and the participant.

orgId
string

The id to identify the orgnaization.

host
boolean

The value is true or flase, it indicates if the participant is the host of the meeting.

coHost
boolean

The value is true or flase, it indicates if the participant has host privilege in the meeting.

spaceModerator
boolean

The value is true or false, it indicates if the participant is the team space moderator. This field returns only if the meeting is associated with a Webex Teams space.

email
string

The email address of the participant

displayName
string

The name of the participant.

invitee
boolean

The value is true or flase, it indicates if the participant is invited to the meeting or not.

video
string

The value is on or off, it indicates the participant's video is on in the meeting.

muted
boolean

The value is true or false, it indicates whether the participant's audio is muted.

state
string

The value can be "lobby" or "joined"

devices
array
deviceType
string

The type of device.

audioType
string

The audio call type, it can be "pstn" or "voip".

joinedTime
string

The time when the device joined.

correlationId
string

An internal id that associated with each join.

Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
PUT
/v1/meetingParticipants/
Log in to try the API.
Header
Body
  • The value is true or false, and means to mute or unmute the audio of a participant.
  • The value can be true or false. The value of true is to admit a participant to the meeting if the participant is in the lobby, No-Op if the participant is not in the lobby or when the value is set to false.
  • The attribute is exclusive and its value can be true or false. The value of true means that the participant will be expelled from the meeting, the value of false means No-Op.
https://webexapis.com/v1/meetingParticipants/560d7b784f5143e3be2fc3064a5c4999_3c2e2338-e950-43bf-b588-573773ee43d1
{
    "muted": false
}
200 / OK
{
  "id": "560d7b784f5143e3be2fc3064a5c4999_3c2e2338-e950-43bf-b588-573773ee43d1",
  "orgId": "1eb65fdf-9643-417f-9974-ad72cae0e10f",
  "host": true,
  "coHost": false,
  "spaceModerator": false,
  "email": "joeDoe@cisco.com",
  "displayName": "Joe Doe",
  "invitee": false,
  "video": "on",
  "muted": false,
  "state": "lobby",
  "devices": [
    {
      "deviceType": "mac",
      "audioType": "pstn",
      "joinedTime": "2019-04-23T17:31:00.000Z",
      "correlationId": "8ccced6c-b812-4dff-a5dd-4c5c28f8d47d"
    }
  ]
}