DocumentationBlogSupport
Log inSign up
Log inSign up
BlogSupport
Build
Getting StartedPlatform Introduction
Embedded Apps
OverviewDeveloper GuideSubmission Checklist for Embedded Apps
Design Guidelines
MeetingsMessagingDevices
API Reference
BotsButtons and CardsIntegrationsLogin with WebexWidgetsGuest IssuerWebex ConnectInstant Connect Meeting LinksDeveloper SandboxSubmit Your AppSupport PolicyFAQs
APIs
XML API DeprecationGetting StartedREST API BasicsComplianceWebhooksWebex APIs
Admin
OverviewAdmin APIsAuthentication
Guides
Hybrid ServicesWebhooksReal-time File DLP Basics
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting QualitiesOrganizationsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSession TypesSpace ClassificationsTracking CodesWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Workspace SettingsWholesale Billing ReportsWorkspace LocationsWorkspace MetricsWorkspaces
Calling
Overview
Guides
Integrations and AuthorizationWebex for BroadWorksWebex for WholesaleWholesale and Broadworks Common Guide
Reference
BroadWorks Billing ReportsBroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks SubscribersCall ControlsLocationsPeopleRecording ReportVideo MeshWebex Calling Detailed Call HistoryWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Voice MessagingWebex Calling Workspace SettingsWholesale Billing ReportsWholesale CustomersWholesale Subscribers
Contact Center
Overview
Devices
Overview
Guides
DevicesWorkspace Integrations Guide
Reference
Device ConfigurationsDevicesWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
Meetings
Overview
Guides
Integrations and AuthorizationWebhooksWebinar GuideMeeting Resource Guide
Reference
Meeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting Participants
GETList Meeting Participants
POSTQuery Meeting Participants with Email
GETGet Meeting Participant Details
PUTUpdate a Participant
POSTAdmit Participants
Meeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportPeopleRecording ReportRecordingsSession TypesTracking CodesVideo MeshWebhooks
Messaging
Overview
Guides
BotsIntegrations and AuthorizationWebhooksButtons and Cards
Reference
Attachment ActionsEventsMembershipsMessagesPeopleRoom TabsRoomsTeam MembershipsTeamsTracking CodesWebhooks
Webex Assistant Skills
Guides
Skills SDK GuideSkills Developer PortalSkills Reference GuideSkills UX Guide
Overview
FedRAMP
Overview
Guides
Create a BotCreate an IntegrationNotes on API Support
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBroadWorks Billing ReportsBroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks SubscribersCall ControlsDevice ConfigurationsDevicesEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting Participants
GETList Meeting Participants
POSTQuery Meeting Participants with Email
GETGet Meeting Participant Details
PUTUpdate a Participant
POSTAdmit Participants
Meeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportMembershipsMessagesOrganizationsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesRoom TabsRoomsSession TypesSiteSpace ClassificationsTeam MembershipsTeamsTracking CodesVideo MeshWebex Calling Detailed Call HistoryWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Voice MessagingWebex Calling Workspace SettingsWebhooksWholesale Billing ReportsWholesale CustomersWholesale SubscribersWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog
SDKs
iOSAndroidBrowserNode.jsJava
Developer CommunityCertifications

Update a Participant

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

Notes:

  • The owner of the OAuth token calling this API needs to be the meeting host or co-host.

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

There is an inconsistent behavior in Webex Meetings App when all active meeting participants join using Webex Meetings App and the host attempts to change meeting participant status using this API. Requests to mute, un-mute, admit, or expel a meeting participant return a successful response and update the state in the API, but the changes will not be applied to the Webex Meetings App participants. The inconsistent behavior in Webex Meetings App will be corrected in a future release. Workaround: Enable closed captions or enable the Webex Assistant.

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 that identifies the meeting and the participant.

orgId
string

The ID that identifies the organization.

host
boolean

Whether or not the participant is the host of the meeting.

coHost
boolean

Whether or not the participant has host privilege in the meeting.

spaceModerator
boolean

Whether or not the participant is the team space moderator. This field returns only if the meeting is associated with a Webex space.

email
string

The email address of the participant.

displayName
string

The name of the participant.

invitee
boolean

Whether or not the participant is invited to the meeting.

video
enum

The status of the participant's video.

on
string

The video is turned on.

off
string

The video is turned off.

muted
boolean

Whether or not the participant's audio is muted.

state
enum

The status of the participant in the meeting.

lobby
string

The participant is waiting in the meeting lobby.

joined
string

The participant has joined the meeting.

siteUrl
string

The site URL.

meetingId
string

A unique identifier for the meeting which the participant belongs to.

hostEmail
string

The email address of the host.

devices
array[InProgressDevice]
correlationId
string

An internal ID that is associated with each join.

deviceType
string

The type of device.

audioType
enum

The audio type that the participant is using.

pstn
string

PSTN

voip
string

VoIP

inactive
string

The participant is not connected to audio.

joinedTime
string

The time the device joined the meeting. If the field is non-existent or shows 1970-01-01T00:00:00.000Z the meeting may be still ongoing and the joinedTime will be filled in after the meeting ended. If you need real-time joined events, please refer to the webhooks guide.

leftTime
string

The time the device left the meeting, leftTime is the exact moment when a specific device left the meeting. If the field is non-existent or shows 1970-01-01T00:00:00.000Z the meeting may be still ongoing and the leftTime will be filled in after the meeting ended. If you need real-time left events, please refer to the webhooks guide.

Response Codes

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

CodeStatusDescription
200OKSuccessful request with body content.
201CreatedThe request has succeeded and has led to the creation of a resource.
202AcceptedThe request has been accepted for processing.
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.
  • Try it
  • Example
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.
  • Request
  • Response
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",
  "siteUrl": "example.webex.com",
  "meetingId": "3a688f62840346e8b87dde2b50703511_I_197977258267247872",
  "hostEmail": "janeDoe@cisco.com",
  "devices": [
    {
      "correlationId": "8ccced6c-b812-4dff-a5dd-4c5c28f8d47d",
      "deviceType": "mac",
      "audioType": "pstn",
      "joinedTime": "2019-04-23T17:31:00.000Z",
      "leftTime": "2019-04-23T17:32:00.000Z"
    }
  ]
}

Connect

Support

Developer Events

Contact Sales

Handy Links

Webex Ambassadors

Webex App Hub

Resources

Open Source Bot Starter Kits

Download Webex

DevNet Learning Labs

Terms of Service

Privacy Policy

Cookie Policy

Trademarks

© 2023 Cisco and/or its affiliates. All rights reserved.