Update Video Options

Updates video options for the authenticated user.

PUT/v1/meetingPreferences/video
Body Parameters
videoDevices
arrayrequired

Array of video devices. If the array is not empty, one device and no more than one devices must be set as default device.

Response Properties
videoDevices
array

Array of video devices. This attribute can be modified by Update Video Options API.

deviceName
string

Video system name. It cannot be empty. This attribute can be modified by Update Video Options API.

deviceAddress
string

Video address. It cannot be empty and must be in valid email format. This attribute can be modified by Update Video Options API.

isDefault
boolean

Flag identifying the device as the default video device. If user's video device list is not empty, one and only one device must be set as default. This attribute can be modified by Update Video Options API.

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.
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.
PUT
/v1/meetingPreferences/video
Log in to try the API.
Header
Body
  • Array of video devices. If the array is not empty, one device and no more than one devices must be set as default device.
{
    "videoDevices": [
        {
            "deviceName": "device1",
            "deviceAddress": "device1@example.com",
            "isDefault": false
        },
        {
            "deviceName": "device2",
            "deviceAddress": "device2@example.com",
            "isDefault": true
        }
    ]
}
200 / OK
{
    "videoDevices": [
        {
            "deviceName": "device1",
            "deviceAddress": "device1@example.com",
            "isDefault": false
        },
        {
            "deviceName": "device2",
            "deviceAddress": "device2@example.com",
            "isDefault": true
        }
    ]
}