openapi: 3.0.0 info: title: Webex Admin Address Book Preferences API version: 1.0.0 description: The Webex Admin APIs provide comprehensive programmatic access to administrative functions for managing Webex organizations, users, licenses, and settings. These APIs enable automation of user provisioning, license assignment, compliance management, and audit event retrieval. Administrators can integrate with enterprise identity systems, enforce security policies, monitor usage, and streamline onboarding/offboarding processes. The APIs support granular control over organizational resources, making them ideal for large-scale deployments and custom admin tooling. tags: - name: Preferences paths: /meetingPreferences: get: responses: '200': description: OK headers: {} content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MeetingPreferenceObject' example: audio: defaultAudioType: webexAudio otherTeleconferenceDescription: Example Description enabledGlobalCallIn: true enabledTollFree: false enabledAutoConnection: false audioPin: '1314' officeNumber: countryCode: '123' number: '123456' enabledCallInAuthentication: false enabledCallMe: false mobileNumber: countryCode: '1' number: '123456789' enabledCallInAuthentication: false enabledCallMe: true video: videoDevices: - deviceName: device1 deviceAddress: device1@example.com isDefault: false - deviceName: device2 deviceAddress: device2@example.com isDefault: true schedulingOptions: enabledJoinBeforeHost: false joinBeforeHostMinutes: 0 enabledAutoShareRecording: false enabledWebexAssistantByDefault: false delegateEmails: - marcus.hoffmann@example.com - brenda.song@example.com sites: - siteUrl: site1-example.webex.com default: false - siteUrl: site2-example.webex.com default: false - siteUrl: site3-example.webex.com default: false - siteUrl: site4-example.webex.com default: true personalMeetingRoom: topic: John's PMR hostPin: '4325' enabledAutoLock: false autoLockMinutes: 10 enabledNotifyHost: true supportCoHost: true supportAnyoneAsCoHost: false allowFirstUserToBeCoHost: false allowAuthenticatedDevices: false coHosts: - email: john.andersen@example.com displayName: John Andersen personalMeetingRoomLink: https://site4-example.webex.com/meet/john sipAddress: john.andersen@example.com dialInIpAddress: 192.168.100.100 telephony: accessCode: '1234567890' callInNumbers: - label: US Toll callInNumber: '123456789' tollType: toll links: - rel: globalCallinNumbers href: /v1/meetings/0fc6ec1109e0d9b6c94e1f6caccda976/globalCallinNumbers method: GET '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: Forbidden headers: {} content: application/json;charset=UTF-8: schema: type: object properties: message: type: string errors: type: array items: type: object properties: description: type: string trackingId: type: string example: message: The server understood the request, but refused to fulfill it because the access token is missing required scopes or the user is missing required roles or licenses. errors: - description: Not permitted to view or change other user's preferences. trackingId: B4A8FB611CFE4BF697CC49B345730269_1572666125876 '404': description: 'Not Found: The 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.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The 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.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The 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.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too 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.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Meeting Preference Details operationId: Get Meeting Preference Details description: Retrieves meeting preferences for the authenticated user. tags: - Preferences parameters: - name: userEmail in: query description: Email address for the user. This parameter is only used if the user or application calling the API has the required [admin-level scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return details of the meeting preferences for that user. example: john.andersen@example.com schema: type: string - name: siteUrl in: query description: URL of the Webex site to query. For individual use, if `siteUrl` is not specified, the query will use the default site of the user. For admin use, if `siteUrl` is not specified, the query will use the default site for the admin's authorization token used to make the call. In the case where the user belongs to a site different than the admin’s default site, the admin can set the site to query using the `siteUrl` parameter. All available Webex sites and default site of a user can be retrieved from [/meetingPreferences/sites](/docs/api/v1/meeting-preferences/get-site-list). example: site4-example.webex.com schema: type: string /meetingPreferences/personalMeetingRoom: get: responses: '200': description: OK headers: {} content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/PMRObject' example: topic: John's PMR hostPin: '4325' enabledAutoLock: false autoLockMinutes: 10 enabledNotifyHost: true supportCoHost: true supportAnyoneAsCoHost: false allowFirstUserToBeCoHost: false allowAuthenticatedDevices: false coHosts: - email: john.andersen@example.com displayName: John Andersen personalMeetingRoomLink: https://site4-example.webex.com/meet/john sipAddress: john.andersen@example.com dialInIpAddress: 192.168.100.100 telephony: accessCode: '1234567890' callInNumbers: - label: US Toll callInNumber: '123456789' tollType: toll links: - rel: globalCallinNumbers href: /v1/meetings/0fc6ec1109e0d9b6c94e1f6caccda976/globalCallinNumbers method: GET '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: Forbidden headers: {} content: application/json;charset=UTF-8: schema: type: object properties: message: type: string errors: type: array items: type: object properties: description: type: string trackingId: type: string example: message: Not permitted to view or change other user's preferences errors: - description: Not permitted to view or change other user's preferences trackingId: C385085C959545C8813E51803297E132_1562293603899 '404': description: 'Not Found: The 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.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The 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.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The 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.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too 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.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Personal Meeting Room Options operationId: Get Personal Meeting Room Options description: Retrieves the Personal Meeting Room options for the authenticated user. tags: - Preferences parameters: - name: userEmail in: query description: Email address for the user. This parameter is only used if the user or application calling the API has the [admin-level scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return details of the Personal Meeting Room options for that user. example: john.andersen@example.com schema: type: string - name: siteUrl in: query description: URL of the Webex site to query. For individual use, if `siteUrl` is not specified, the query will use the default site of the user. For admin use, if `siteUrl` is not specified, the query will use the default site for the admin's authorization token used to make the call. In the case where the user belongs to a site different than the admin’s default site, the admin can set the site to query using the `siteUrl` parameter. All available Webex sites and default site of a user can be retrieved from [/meetingPreferences/sites](/docs/api/v1/meeting-preferences/get-site-list). example: site4-example.webex.com schema: type: string put: responses: '200': description: OK headers: {} content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/PMRObject' example: topic: John's PMR hostPin: '4325' enabledAutoLock: false autoLockMinutes: 10 enabledNotifyHost: true supportCoHost: true supportAnyoneAsCoHost: false allowFirstUserToBeCoHost: false allowAuthenticatedDevices: false coHosts: - email: john.andersen@example.com displayName: John Andersen personalMeetingRoomLink: https://site4-example.webex.com/meet/john sipAddress: john.andersen@example.com dialInIpAddress: 192.168.100.100 telephony: accessCode: '1234567890' callInNumbers: - label: US Toll callInNumber: '123456789' tollType: toll links: - rel: globalCallinNumbers href: /v1/meetings/0fc6ec1109e0d9b6c94e1f6caccda976/globalCallinNumbers method: GET '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: Forbidden headers: {} content: application/json;charset=UTF-8: schema: type: object properties: message: type: string errors: type: array items: type: object properties: description: type: string trackingId: type: string example: message: The server understood the request, but refused to fulfill it because the access token is missing required scopes or the user is missing required roles or licenses. errors: - description: Not permitted to view or change other user's preferences. trackingId: 4A78EB66D02E4C78B9955AA504ECFC3D_1572666592909 '404': description: 'Not Found: The 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.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The 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.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The 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.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too 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.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Update Personal Meeting Room Options operationId: Update Personal Meeting Room Options description: Updates Personal Meeting Room options for the authenticated user. tags: - Preferences parameters: - name: userEmail in: query description: Email address for the user. This parameter is only used if the user or application calling the API has the [admin-level scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will update Personal Meeting Room options for that user. example: john.andersen@example.com schema: type: string - name: siteUrl in: query description: URL of the Webex site to query. For individual use, if `siteUrl` is not specified, the query will use the default site of the user. For admin use, if `siteUrl` is not specified, the query will use the default site for the admin's authorization token used to make the call. In the case where the user belongs to a site different than the admin’s default site, the admin can set the site to query using the `siteUrl` parameter. All available Webex sites and default site of a user can be retrieved from [/meetingPreferences/sites](/docs/api/v1/meeting-preferences/get-site-list). example: site4-example.webex.com schema: type: string requestBody: content: application/json: example: topic: John's PMR hostPin: '4325' enabledAutoLock: false autoLockMinutes: 10 enabledNotifyHost: true supportCoHost: true supportAnyoneAsCoHost: false allowFirstUserToBeCoHost: false allowAuthenticatedDevices: false coHosts: - email: john.andersen@example.com displayName: John Andersen schema: $ref: '#/components/schemas/UpdatePMRObject' /meetingPreferences/audio: get: responses: '200': description: OK headers: {} content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AudioObject' example: defaultAudioType: webexAudio otherTeleconferenceDescription: Example Description enabledGlobalCallIn: true enabledTollFree: false enabledAutoConnection: false audioPin: '1314' officeNumber: countryCode: '123' number: '123456' enabledCallInAuthentication: false enabledCallMe: false mobileNumber: countryCode: '1' number: '123456789' enabledCallInAuthentication: false enabledCallMe: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: Forbidden headers: {} content: application/json;charset=UTF-8: schema: type: object properties: message: type: string errors: type: array items: type: object properties: description: type: string trackingId: type: string example: message: The server understood the request, but refused to fulfill it because the access token is missing required scopes or the user is missing required roles or licenses. errors: - description: Not permitted to view or change other user's preferences. trackingId: 4A78EB66D02E4C78B9955AA504ECFC3D_1572666592909 '404': description: 'Not Found: The 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.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The 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.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The 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.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too 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.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Audio Options operationId: Get Audio Options description: Retrieves audio options for the authenticated user. tags: - Preferences parameters: - name: userEmail in: query description: Email address for the user. This parameter is only used if the user or application calling the API has the [admin-level scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return details of the audio options for that user. example: john.andersen@example.com schema: type: string - name: siteUrl in: query description: URL of the Webex site to query. For individual use, if `siteUrl` is not specified, the query will use the default site of the user. For admin use, if `siteUrl` is not specified, the query will use the default site for the admin's authorization token used to make the call. In the case where the user belongs to a site different than the admin’s default site, the admin can set the site to query using the `siteUrl` parameter. All available Webex sites and default site of a user can be retrieved from [/meetingPreferences/sites](/docs/api/v1/meeting-preferences/get-site-list). example: site4-example.webex.com schema: type: string put: responses: '200': description: OK headers: {} content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AudioObject' example: defaultAudioType: webexAudio otherTeleconferenceDescription: Example Description enabledGlobalCallIn: true enabledTollFree: false enabledAutoConnection: false audioPin: '1314' officeNumber: countryCode: '123' number: '123456' enabledCallInAuthentication: false enabledCallMe: false mobileNumber: countryCode: '1' number: '123456789' enabledCallInAuthentication: false enabledCallMe: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: Forbidden headers: {} content: application/json;charset=UTF-8: schema: type: object properties: message: type: string errors: type: array items: type: object properties: description: type: string trackingId: type: string example: message: The server understood the request, but refused to fulfill it because the access token is missing required scopes or the user is missing required roles or licenses. errors: - description: Not permitted to view or change other user's preferences. trackingId: 4A78EB66D02E4C78B9955AA504ECFC3D_1572666592909 '404': description: 'Not Found: The 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.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The 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.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The 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.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too 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.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Update Audio Options operationId: Update Audio Options description: Updates audio options for the authenticated user. tags: - Preferences parameters: - name: userEmail in: query description: Email address for the user. This parameter is only used if the user or application calling the API has the [admin-level scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will update audio options for that user. example: john.andersen@example.com schema: type: string - name: siteUrl in: query description: URL of the Webex site to query. For individual use, if `siteUrl` is not specified, the query will use the default site of the user. For admin use, if `siteUrl` is not specified, the query will use the default site for the admin's authorization token used to make the call. In the case where the user belongs to a site different than the admin’s default site, the admin can set the site to query using the `siteUrl` parameter. All available Webex sites and default site of a user can be retrieved from [/meetingPreferences/sites](/docs/api/v1/meeting-preferences/get-site-list). example: site4-example.webex.com schema: type: string requestBody: content: application/json: example: defaultAudioType: webexAudio otherTeleconferenceDescription: Example Description enabledGlobalCallIn: true enabledTollFree: false enabledAutoConnection: false audioPin: '1314' officeNumber: countryCode: '123' number: '123456' enabledCallInAuthentication: false enabledCallMe: false mobileNumber: countryCode: '1' number: '123456789' enabledCallInAuthentication: false enabledCallMe: true schema: $ref: '#/components/schemas/AudioObject' /meetingPreferences/video: get: responses: '200': description: OK headers: {} content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/GetVideoObject' example: videoDevices: - deviceName: device1 deviceAddress: device1@example.com isDefault: false - deviceName: device2 deviceAddress: device2@example.com isDefault: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: Forbidden headers: {} content: application/json;charset=UTF-8: schema: type: object properties: message: type: string errors: type: array items: type: object properties: description: type: string trackingId: type: string example: message: The server understood the request, but refused to fulfill it because the access token is missing required scopes or the user is missing required roles or licenses. errors: - description: Not permitted to view or change other user's preferences. trackingId: 4A78EB66D02E4C78B9955AA504ECFC3D_1572666592909 '404': description: 'Not Found: The 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.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The 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.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The 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.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too 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.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Video Options operationId: Get Video Options description: Retrieves video options for the authenticated user. tags: - Preferences parameters: - name: userEmail in: query description: Email address for the user. This parameter is only used if the user or application calling the API has the [admin-level scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return details of the video options for that user. example: john.andersen@example.com schema: type: string - name: siteUrl in: query description: URL of the Webex site to query. For individual use, if `siteUrl` is not specified, the query will use the default site of the user. For admin use, if `siteUrl` is not specified, the query will use the default site for the admin's authorization token used to make the call. In the case where the user belongs to a site different than the admin’s default site, the admin can set the site to query using the `siteUrl` parameter. All available Webex sites and default site of a user can be retrieved using [Get Site List](/docs/api/v1/meeting-preferences/get-site-list). example: site4-example.webex.com schema: type: string put: responses: '200': description: OK headers: {} content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/GetVideoObject' example: videoDevices: - deviceName: device1 deviceAddress: device1@example.com isDefault: false - deviceName: device2 deviceAddress: device2@example.com isDefault: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: Forbidden headers: {} content: application/json;charset=UTF-8: schema: type: object properties: message: type: string errors: type: array items: type: object properties: description: type: string trackingId: type: string example: message: The server understood the request, but refused to fulfill it because the access token is missing required scopes or the user is missing required roles or licenses. errors: - description: Not permitted to view or change other user's preferences. trackingId: 4A78EB66D02E4C78B9955AA504ECFC3D_1572666592909 '404': description: 'Not Found: The 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.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The 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.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The 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.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too 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.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Update Video Options operationId: Update Video Options description: Updates video options for the authenticated user. tags: - Preferences parameters: - name: userEmail in: query description: Email address for the user. This parameter is only used if the user or application calling the API has the [admin-level scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will update video options for that user. example: john.andersen@example.com schema: type: string - name: siteUrl in: query description: URL of the Webex site to query. For individual use, if `siteUrl` is not specified, the query will use the default site of the user. For admin use, if `siteUrl` is not specified, the query will use the default site for the admin's authorization token used to make the call. In the case where the user belongs to a site different than the admin’s default site, the admin can set the site to query using the `siteUrl` parameter. All available Webex sites and default site of a user can be retrieved from [/meetingPreferences/sites](/docs/api/v1/meeting-preferences/get-site-list). example: site4-example.webex.com schema: type: string requestBody: content: application/json: example: videoDevices: - deviceName: device1 deviceAddress: device1@example.com isDefault: false - deviceName: device2 deviceAddress: device2@example.com isDefault: true schema: $ref: '#/components/schemas/UpdateVideoObject' /meetingPreferences/schedulingOptions: get: responses: '200': description: OK headers: {} content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/SchedulingOptionsObject' example: enabledJoinBeforeHost: false joinBeforeHostMinutes: 10 enabledAutoShareRecording: false enabledWebexAssistantByDefault: false delegateEmails: - marcus.hoffmann@example.com - brenda.song@example.com '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: Forbidden headers: {} content: application/json;charset=UTF-8: schema: type: object properties: message: type: string errors: type: array items: type: object properties: description: type: string trackingId: type: string example: message: The server understood the request, but refused to fulfill it because the access token is missing required scopes or the user is missing required roles or licenses. errors: - description: Not permitted to view or change other user's preferences. trackingId: 4A78EB66D02E4C78B9955AA504ECFC3D_1572666592909 '404': description: 'Not Found: The 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.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The 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.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The 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.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too 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.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Scheduling Options operationId: Get Scheduling Options description: Retrieves scheduling options for the authenticated user. tags: - Preferences parameters: - name: userEmail in: query description: Email address for the user. This parameter is only used if the user or application calling the API has the [admin-level scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return details of the scheduling options for that user. example: john.andersen@example.com schema: type: string - name: siteUrl in: query description: URL of the Webex site to query. For individual use, if `siteUrl` is not specified, the query will use the default site of the user. For admin use, if `siteUrl` is not specified, the query will use the default site for the admin's authorization token used to make the call. In the case where the user belongs to a site different than the admin’s default site, the admin can set the site to query using the `siteUrl` parameter. All available Webex sites and default site of a user can be retrieved from [/meetingPreferences/sites](/docs/api/v1/meeting-preferences/get-site-list). example: site4-example.webex.com schema: type: string put: responses: '200': description: OK headers: {} content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/SchedulingOptionsObject' example: enabledJoinBeforeHost: false joinBeforeHostMinutes: 10 enabledAutoShareRecording: false enabledWebexAssistantByDefault: false delegateEmails: - marcus.hoffmann@example.com - brenda.song@example.com '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: Forbidden headers: {} content: application/json;charset=UTF-8: schema: type: object properties: message: type: string errors: type: array items: type: object properties: description: type: string trackingId: type: string example: message: The server understood the request, but refused to fulfill it because the access token is missing required scopes or the user is missing required roles or licenses. errors: - description: Not permitted to view or change other user's preferences. trackingId: 4A78EB66D02E4C78B9955AA504ECFC3D_1572666592909 '404': description: 'Not Found: The 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.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The 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.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The 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.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too 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.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Update Scheduling Options operationId: Update Scheduling Options description: 'Updates scheduling options for the authenticated user. * If `delegateEmails` is null or not specified, the user''s delegate emails are not changed. If `delegateEmails` is specified and not empty, the user''s delegate emails are updated with the specified emails. If `delegateEmails` is specified as an empty array, the user''s existing delegate emails are removed.' tags: - Preferences parameters: - name: userEmail in: query description: Email address for the user. This parameter is only used if the user or application calling the API has the [admin-level scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will update scheduling options for that user. example: john.andersen@example.com schema: type: string - name: siteUrl in: query description: URL of the Webex site to query. For individual use, if `siteUrl` is not specified, the query will use the default site of the user. For admin use, if `siteUrl` is not specified, the query will use the default site for the admin's authorization token used to make the call. In the case where the user belongs to a site different than the admin’s default site, the admin can set the site to query using the `siteUrl` parameter. All available Webex sites and default site of a user can be retrieved from [/meetingPreferences/sites](/docs/api/v1/meeting-preferences/get-site-list). example: site4-example.webex.com schema: type: string requestBody: content: application/json: example: enabledJoinBeforeHost: false joinBeforeHostMinutes: 0 enabledAutoShareRecording: false enabledWebexAssistantByDefault: false delegateEmails: - marcus.hoffmann@example.com, brenda.song@example.com schema: $ref: '#/components/schemas/SchedulingOptionsObject' /meetingPreferences/schedulingOptions/delegateEmails/insert: post: responses: '200': description: OK headers: {} content: application/json;charset=UTF-8: schema: type: object properties: emails: type: array items: type: string example: emails: - marcus.hoffmann@example.com - brenda.song@example.com '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: Forbidden headers: {} content: application/json;charset=UTF-8: schema: type: object properties: message: type: string errors: type: array items: type: object properties: description: type: string trackingId: type: string example: message: The server understood the request, but refused to fulfill it because the access token is missing required scopes or the user is missing required roles or licenses. errors: - description: Not permitted to view or change other user's preferences. trackingId: 4A78EB66D02E4C78B9955AA504ECFC3D_1572666592909 '404': description: 'Not Found: The 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.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The 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.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The 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.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too 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.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Insert Delegate Emails operationId: Insert Delegate Emails description: Insert delegate emails for the authenticated user. tags: - Preferences parameters: - name: userEmail in: query description: Email address for the user. This parameter is only used if the user or application calling the API has the [admin-level scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will update scheduling options for that user. example: john.andersen@example.com schema: type: string - name: siteUrl in: query description: URL of the Webex site to query. For individual use, if `siteUrl` is not specified, the query will use the default site of the user. For admin use, if `siteUrl` is not specified, the query will use the default site for the admin's authorization token used to make the call. In the case where the user belongs to a site different than the admin’s default site, the admin can set the site to query using the `siteUrl` parameter. All available Webex sites and default site of a user can be retrieved from [/meetingPreferences/sites](/docs/api/v1/meeting-preferences/get-site-list). example: site4-example.webex.com schema: type: string requestBody: content: application/json: example: emails: - marcus.hoffmann@example.com, brenda.song@example.com schema: $ref: '#/components/schemas/SchedulingOptionsDelegateEmailsObject' /meetingPreferences/schedulingOptions/delegateEmails/delete: post: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The 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.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The 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.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The 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.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too 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.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete Delegate Emails operationId: Delete Delegate Emails description: Delete delegate emails for the authenticated user. tags: - Preferences parameters: - name: userEmail in: query description: Email address for the user. This parameter is only used if the user or application calling the API has the [admin-level scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will update scheduling options for that user. example: john.andersen@example.com schema: type: string - name: siteUrl in: query description: URL of the Webex site to query. For individual use, if `siteUrl` is not specified, the query will use the default site of the user. For admin use, if `siteUrl` is not specified, the query will use the default site for the admin's authorization token used to make the call. In the case where the user belongs to a site different than the admin’s default site, the admin can set the site to query using the `siteUrl` parameter. All available Webex sites and default site of a user can be retrieved from [/meetingPreferences/sites](/docs/api/v1/meeting-preferences/get-site-list). example: site4-example.webex.com schema: type: string requestBody: content: application/json: example: emails: - marcus.hoffmann@example.com, brenda.song@example.com schema: $ref: '#/components/schemas/SchedulingOptionsDelegateEmailsObject' /meetingPreferences/sites: get: responses: '200': description: OK headers: {} content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/SitesObject' example: sites: - siteUrl: site1-example.webex.com default: false - siteUrl: site2-example.webex.com default: false - siteUrl: site3-example.webex.com default: false - siteUrl: site4-example.webex.com default: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: Forbidden headers: {} content: application/json;charset=UTF-8: schema: type: object properties: message: type: string errors: type: array items: type: object properties: description: type: string trackingId: type: string example: message: The server understood the request, but refused to fulfill it because the access token is missing required scopes or the user is missing required roles or licenses. errors: - description: Not permitted to view or change other user's preferences. trackingId: 4A78EB66D02E4C78B9955AA504ECFC3D_1572666592909 '404': description: 'Not Found: The 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.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The 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.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The 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.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too 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.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Site List operationId: Get Site List description: 'Retrieves the list of Webex sites that the authenticated user is set up to use. When the admin tries to get the site list via `userEmail`, if `siteUrl` is not specified, the API searches the user ID from the admin''s default site. If `siteUrl` is specified, the API searches the user ID from the specified site.' tags: - Preferences parameters: - name: userEmail in: query description: Email address for the user. This parameter is only used if the user or application calling the API has the [admin-level scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user and the API will return the list of Webex sites for that user. example: john.andersen@example.com schema: type: string - name: siteUrl in: query description: URL of the Webex site to query. If `siteUrl` is not specified, the query will use the default site for the admin's authorization token used to make the call. example: site4-example.webex.com schema: type: string put: responses: '200': description: OK headers: {} content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/SiteObject' example: siteUrl: site4-example.webex.com default: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: Forbidden headers: {} content: application/json;charset=UTF-8: schema: type: object properties: message: type: string errors: type: array items: type: object properties: description: type: string trackingId: type: string example: message: The server understood the request, but refused to fulfill it because the access token is missing required scopes or the user is missing required roles or licenses. errors: - description: Not permitted to view or change other user's preferences. trackingId: 4A78EB66D02E4C78B9955AA504ECFC3D_1572666592909 '404': description: 'Not Found: The 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.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The 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.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The 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.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too 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.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Update Default Site operationId: Update Default Site description: Updates the default site for the authenticated user. tags: - Preferences parameters: - name: defaultSite in: query description: 'Whether or not to change user''s default site. ***Note***: `defaultSite` should be set to true for the user''s single default site' required: true example: 'true' schema: type: boolean - name: userEmail in: query description: Email address for the user. This parameter is only used if the user or application calling the API has the [admin-level scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will update default site for that user. example: john.andersen@example.com schema: type: string requestBody: content: application/json: example: siteUrl: site4-example.webex.com schema: $ref: '#/components/schemas/DefaultSiteObject' /admin/meetingPreferences/personalMeetingRoom/refreshId: post: responses: '200': description: OK headers: {} content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/BatchRefreshPMRIDResponseObject' example: siteUrl: example.webex.com personalMeetingRoomIds: - email: john.andersen@example.com personId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZ personalMeetingRoomId: prABCD23670651 - email: marcus.hoffmann@example.com personId: sdfeY28890KLFHzovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZ personalMeetingRoomId: prABCD99751428 - email: brenda.song@example.com personId: FYG98gxYy1AYOP086VMLOUYTTCCN0IYTAio2uydbzlkyjYTQ0LTRmZ personalMeetingRoomId: prABCD56290641 '400': description: Bad Request headers: {} content: application/json;charset=UTF-8: schema: type: object properties: message: type: string errors: type: array items: type: object properties: description: type: string example: message: The request could not be understood by the server due to malformed syntax. See 'errors' for more details. errors: - description: Personal meeting room ID is being used by someone else. '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The 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.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The 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.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The 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.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too 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.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Batch Refresh Personal Meeting Room ID operationId: Batch Refresh Personal Meeting Room ID description: 'Refreshes personal room IDs automatically according to the current personal room ID rule of the target site or by the values specified by the admin user. The new personal room IDs are generated by the site''s settings automatically if `systemGenerated` is true; otherwise, replace the existing personal room IDs with the specified values if `systemGenerated` is false or not specified. It may take up to 30 minutes to see the updated personal room ID on the Webex meeting page after refreshing the personal room ID due to cache. Either all items in `personalMeetingRoomIds` have `personalMeetingRoomId`, or they all have `systemGenerated` which equals true. `personalMeetingRoomId` and `systemGenerated: true` cannot be specified at the same time. The items in `personalMeetingRoomIds` either all have `personId` or all have `email` in a single request. Partial `personId` and partial `email` is not allowed in the same request.' tags: - Preferences parameters: [] requestBody: content: application/json: example: siteUrl: example.webex.com personalMeetingRoomIds: - email: john.andersen@example.com personalMeetingRoomId: prABCD23670651 - email: marcus.hoffmann@example.com personalMeetingRoomId: prABCD99751428 - email: brenda.song@example.com personalMeetingRoomId: prABCD56290641 schema: $ref: '#/components/schemas/BatchRefreshPMRIDObject' components: schemas: PMRIDResponseObject: type: object properties: email: type: string example: john.andersen@example.com description: Email address for the meeting host whose personal room ID has been refreshed. personId: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8yNWJiZjgzMS01YmU5LTRjMjUtYjRiMC05YjU5MmM4YTA4NmI description: Unique identifier for the meeting host whose personal room ID has been refreshed. personalMeetingRoomId: type: string example: prABCD23670651 description: Refreshed personal room ID. PMRIDObject: type: object properties: email: type: string example: john.andersen@example.com description: Email address of the meeting host whose personal room ID will be refreshed. personId: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8yNWJiZjgzMS01YmU5LTRjMjUtYjRiMC05YjU5MmM4YTA4NmI description: Unique identifier for the meeting host whose personal room ID will be refreshed. systemGenerated: type: boolean description: Whether or not to automatically refresh the personal room ID by the site's settings. Refresh the personal room ID by the site's settings automatically if `systemGenerated` is true; otherwise, replace the existing personal room ID with the specified value if `systemGenerated` is false or not specified. personalMeetingRoomId: type: string example: prABCD23670651 description: New personal room ID specified by the admin user. PMRObject: type: object required: - topic - hostPin - personalMeetingRoomLink - enabledAutoLock - enabledNotifyHost - supportCoHost - sipAddress - dialInIpAddress - telephony properties: topic: type: string example: John's PMR description: Personal Meeting Room topic. The length of `topic` is between 1 and 128. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API. hostPin: type: string example: '4325' description: PIN for joining the room as host. The host PIN must be digits of a predefined length, e.g. 4 digits. It cannot contain sequential digits, such as 1234 or 4321, or repeated digits of the predefined length, such as 1111. The predefined length for host PIN can be viewed in user's `My Personal Room` page and it can only be changed by site administrator. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API. personalMeetingRoomLink: type: string example: https://site4-example.webex.com/meet/john description: 'Personal Meeting Room link. It cannot be empty. ***Note***: This is a read-only attribute.' enabledAutoLock: type: boolean description: Option to automatically lock the Personal Room a number of minutes after a meeting starts. When a room is locked, invitees cannot enter until the owner admits them. The period after which the meeting is locked is defined by `autoLockMinutes`. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API. autoLockMinutes: type: number description: Number of minutes after which the Personal Room is locked if `enabledAutoLock` is enabled. Valid options are 0, 5, 10, 15 and 20. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API. enabledNotifyHost: type: boolean description: Flag to enable notifying the owner of a Personal Room when someone enters the Personal Room lobby while the owner is not in the room. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API. supportCoHost: type: boolean description: Flag allowing other invitees to host a meeting in the Personal Room without the owner. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API. supportAnyoneAsCoHost: type: boolean description: Whether or not to allow any attendee with a host account on the target site to become a cohost when joining the Personal Room. The target site is user's preferred site. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API. allowFirstUserToBeCoHost: type: boolean description: Whether or not to allow the first attendee with a host account on the target site to become a cohost when joining the Personal Room. The target site is user's preferred site. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API. allowAuthenticatedDevices: type: boolean description: Whether or not to allow authenticated video devices in the user's organization to start or join the meeting without a prompt. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API. coHosts: type: array items: type: object required: - email - displayName properties: email: type: string example: john.andersen@example.com description: Email address for cohost. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API. displayName: type: string example: John Andersen description: Display name for cohost. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API. description: Array defining cohosts for the room if both `supportAnyoneAsCoHost` and `allowFirstUserToBeCoHost` are `false`. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API. sipAddress: type: string example: john.andersen@example.com description: SIP address for callback from a video system. dialInIpAddress: type: string example: 192.168.100.100 description: IP address for callback from a video system. telephony: type: object required: - accessCode - callInNumbers properties: accessCode: type: string example: '1234567890' description: Code for authenticating a user to join teleconference. Users join the teleconference using the call-in number or the global call-in number, followed by the value of the `accessCode`. callInNumbers: type: array items: type: object required: - label - callInNumber - tollType properties: label: type: string example: Call-in toll-free number (US/Canada) description: Label for call-in number. callInNumber: type: string example: '123456789' description: Call-in number to join teleconference from a phone. tollType: type: string enum: - toll - tollFree description: Type of toll for the call-in number. description: Array of call-in numbers for joining teleconference from a phone. links: type: object required: - rel - href - method properties: rel: type: string example: globalCallinNumbers description: Link relation describing how the target resource is related to the current context (conforming with [RFC5998](https://tools.ietf.org/html/rfc5988)). href: type: string example: /api/v1/meetings/2c87cf8ece4e414a9fe5516e4a0aac76/globalCallinNumbers description: Target resource URI (conforming with [RFC5998](https://tools.ietf.org/html/rfc5988)). method: type: string example: GET description: Target resource method (conforming with [RFC5998](https://tools.ietf.org/html/rfc5988)). description: '[HATEOAS](https://en.wikipedia.org/wiki/HATEOAS) information of global call-in numbers for joining teleconference from a phone.' description: Information for callbacks from meeting to phone or for joining a teleconference using a phone. SitesObject: type: object required: - sites properties: sites: type: array items: type: object required: - siteUrl - default properties: siteUrl: type: string example: site1-example.webex.com description: 'Access URL for the site. ***Note***: This is a read-only attribute. The value can be assigned as user''s default site with the [Update Default Site](/docs/api/v1/meeting-preferences/update-default-site) API.' default: type: boolean description: Flag identifying the site as the default site. Users can list meetings and recordings, and create meetings on the default site. description: Array of sites for the user. Users can have one site or multiple sites. This concept is specific to Webex Meetings. Any `siteUrl` in the site list can be assigned as user's default site with the [Update Default Site](/docs/api/v1/meeting-preferences/update-default-site) API. UpdateVideoObject: type: object required: - videoDevices properties: videoDevices: type: array items: type: object required: - deviceName - deviceAddress - isDefault properties: deviceName: type: string example: device1 description: Video system name. It cannot be empty. This attribute can be modified with the [Update Video Options](/docs/api/v1/meeting-preferences/update-video-options) API. deviceAddress: type: string example: device1@example.com description: Video address. It cannot be empty and must be in valid email format. This attribute can be modified with the [Update Video Options](/docs/api/v1/meeting-preferences/update-video-options) API. isDefault: type: boolean example: true description: 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 with the [Update Video Options](/docs/api/v1/meeting-preferences/update-video-options) API. description: Array of video devices. If the array is not empty, one device and no more than one devices must be set as default device. SchedulingOptionsObject: type: object required: - enabledJoinBeforeHost - joinBeforeHostMinutes - enabledAutoShareRecording properties: enabledJoinBeforeHost: type: boolean description: 'Flag to enable/disable ***Join Before Host***. The period during which invitees can join before the start time is defined by `autoLockMinutes`. This attribute can be modified with the [Update Scheduling Options](/docs/api/v1/meeting-preferences/update-scheduling-options) API. ***Note***: This feature is only effective if the site supports the ***Join Before Host*** feature. This attribute can be modified with the [Update Scheduling Options](/docs/api/v1/meeting-preferences/update-scheduling-options) API.' joinBeforeHostMinutes: type: number description: Number of minutes before the start time that an invitee can join a meeting if `enabledJoinBeforeHost` is true. Valid options are 0, 5, 10 and 15. This attribute can be modified with the [Update Scheduling Options](/docs/api/v1/meeting-preferences/update-scheduling-options) API. enabledAutoShareRecording: type: boolean description: Flag to enable/disable the automatic sharing of the meeting recording with invitees when it is available. This attribute can be modified with the [Update Scheduling Options](/docs/api/v1/meeting-preferences/update-scheduling-options) API. enabledWebexAssistantByDefault: type: boolean description: Flag to automatically enable Webex Assistant whenever you start a meeting. This attribute can be modified with the [Update Scheduling Options](/docs/api/v1/meeting-preferences/update-scheduling-options) API. delegateEmails: type: array items: type: string example: marcus.hoffmann@example.com, brenda.song@example.com description: You can allow other hosts to schedule meetings on your behalf by entering their email addresses here. This attribute can be modified with the [Update Scheduling Options](/docs/api/v1/meeting-preferences/update-scheduling-options), [Insert Delegate Emails](/docs/api/v1/meeting-preferences/insert-delegate-emails), and [Update Scheduling Options](/docs/api/v1/meeting-preferences/delete-delegate-emails) APIs. GetVideoObject: type: object required: - videoDevices properties: videoDevices: type: array items: type: object required: - deviceName - deviceAddress - isDefault properties: deviceName: type: string example: device1 description: Video system name. It cannot be empty. This attribute can be modified with the [Update Video Options](/docs/api/v1/meeting-preferences/update-video-options) API. deviceAddress: type: string example: device1@example.com description: Video address. It cannot be empty and must be in valid email format. This attribute can be modified with the [Update Video Options](/docs/api/v1/meeting-preferences/update-video-options) API. isDefault: type: boolean example: true description: 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 with the [Update Video Options](/docs/api/v1/meeting-preferences/update-video-options) API. description: Array of video devices. This attribute can be modified with the [Update Video Options](/docs/api/v1/meeting-preferences/update-video-options) API. MeetingPreferenceObject: type: object required: - personalMeetingRoom - audio - video - schedulingOptions properties: personalMeetingRoom: type: object required: - topic - hostPin - personalMeetingRoomLink - enabledAutoLock - enabledNotifyHost - supportCoHost - sipAddress - dialInIpAddress - telephony properties: topic: type: string example: John's PMR description: Personal Meeting Room topic. The length of `topic` must be between 1 and 128 characters. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API. hostPin: type: string example: '4325' description: PIN for joining the room as host. The host PIN must be digits of a predefined length, e.g. 4 digits. It cannot contain sequential digits, such as 1234 or 4321, or repeated digits of the predefined length, such as 1111. The predefined length for host PIN can be viewed in user's `My Personal Room` page. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API. personalMeetingRoomLink: type: string example: https://site4-example.webex.com/meet/john description: 'Personal Meeting Room link. It cannot be empty. ***Note***: This is a read-only attribute.' enabledAutoLock: type: boolean description: Option to automatically lock the Personal Room a number of minutes after a meeting starts. When a room is locked, invitees cannot enter until the owner admits them. The period after which the meeting is locked is defined by `autoLockMinutes`. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API. autoLockMinutes: type: number description: Number of minutes after which the Personal Room is locked if `enabledAutoLock` is enabled. Valid options are 0, 5, 10, 15 and 20. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API. enabledNotifyHost: type: boolean description: Flag to enable notifying the owner of a Personal Room when someone enters the Personal Room lobby while the owner is not in the room. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API. supportCoHost: type: boolean description: Flag allowing other invitees to host a meeting in the Personal Room without the owner. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API. supportAnyoneAsCoHost: type: boolean description: Whether or not to allow any attendee with a host account on the target site to become a cohost when joining the Personal Room. The target site is user's preferred site. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API. allowFirstUserToBeCoHost: type: boolean description: Whether or not to allow the first attendee with a host account on the target site to become a cohost when joining the Personal Room. The target site is user's preferred site. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API. allowAuthenticatedDevices: type: boolean description: Whether or not to allow authenticated video devices in the user's organization to start or join the meeting without a prompt. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API. coHosts: type: array items: type: object required: - email - displayName properties: email: type: string example: john.andersen@example.com description: Email address for cohost. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API. displayName: type: string example: John Andersen description: Display name for cohost. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API. description: Array defining cohosts for the room if both `supportAnyoneAsCoHost` and `allowFirstUserToBeCoHost` are `false` This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API. sipAddress: type: string example: john.andersen@example.com description: SIP address for callback from a video system. dialInIpAddress: type: string example: 192.168.100.100 description: IP address for callback from a video system. telephony: type: object required: - accessCode - callInNumbers properties: accessCode: type: string example: '1234567890' description: Code for authenticating a user to join teleconference. Users join the teleconference using the call-in number or the global call-in number, followed by the value of the `accessCode`. callInNumbers: type: array items: type: object required: - label - callInNumber - tollType properties: label: type: string example: Call-in toll-free number (US/Canada) description: Label for call-in number. callInNumber: type: string example: '123456789' description: Call-in number to join teleconference from a phone. tollType: type: string enum: - toll - tollFree description: Type of toll for the call-in number. description: Array of call-in numbers for joining teleconference from a phone. links: type: object required: - rel - href - method properties: rel: type: string example: globalCallinNumbers description: Link relation describing how the target resource is related to the current context (conforming with [RFC5998](https://tools.ietf.org/html/rfc5988)). href: type: string example: /api/v1/meetings/2c87cf8ece4e414a9fe5516e4a0aac76/globalCallinNumbers description: Target resource URI (conforming with [RFC5998](https://tools.ietf.org/html/rfc5988)). method: type: string example: GET description: Target resource method (conforming with [RFC5998](https://tools.ietf.org/html/rfc5988)). description: '[HATEOAS](https://en.wikipedia.org/wiki/HATEOAS) information of global call-in numbers for joining teleconference from a phone.' description: Information for callbacks from meeting to phone or for joining a teleconference using a phone. description: Personal Meeting Room options. audio: type: object required: - defaultAudioType - otherTeleconferenceDescription - enabledGlobalCallIn - enabledTollFree - enabledAutoConnection - officeNumber - mobileNumber properties: defaultAudioType: type: string enum: - webexAudio - voipOnly - otherTeleconferenceService - none description: "Default audio type. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API.\n * `webexAudio` - Webex audio. This supports telephony and VoIP.\n * `voipOnly` - Support only VoIP.\n * `otherTeleconferenceService` - Other teleconference service. Details are defined in the `otherTeleconferenceDescription` parameter.\n * `none` - No audio.\n" otherTeleconferenceDescription: type: string description: Phone number and other information for the teleconference provider to be used, along with instructions for invitees. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API. enabledGlobalCallIn: type: boolean description: 'Flag to enable/disable global call ins. ***Note***: If the site does not support global call-ins, you cannot set this option. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API.' enabledTollFree: type: boolean description: 'Flag to enable/disable call-ins from toll-free numbers. ***Note***: If the site does not support calls from toll-free numbers, you cannot set this option. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API.' enabledAutoConnection: type: boolean description: Flag to enable/disable automatically connecting to audio using a computer. The meeting host can enable/disable this option. When this option is set to `true`, the user is automatically connected to audio via a computer when they start or join a Webex Meetings meeting on a desktop. `This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API. audioPin: type: string description: PIN to provide a secondary level of authentication for calls where the host is using the phone and may need to invite additional invitees. It must be exactly 4 digits. It cannot contain sequential digits, such as 1234 or 4321, or repeat a digit 4 times, such as 1111. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API. officeNumber: type: object required: - countryCode - number - enabledCallInAuthentication - enabledCallMe properties: countryCode: type: string description: Country code for the phone number. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API. number: type: string description: Phone number. It cannot be longer than 30 characters. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API. enabledCallInAuthentication: type: boolean description: Flag identifying the phone number as the one that will be used to dial into a teleconference. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API. enabledCallMe: type: boolean description: 'Flag to enable/disable Call Me number display on the meeting client. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API. ***Note***: This feature is only effective if the site supports the ***Call Me*** feature.' description: Office phone number. We recommend that phone numbers be specified to facilitate connecting via audio. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API. mobileNumber: type: object required: - countryCode - number - enabledCallInAuthentication - enabledCallMe properties: countryCode: type: string description: Country code for the phone number. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API. number: type: string description: Phone number. It cannot be longer than 30 characters. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API. enabledCallInAuthentication: type: boolean description: Flag identifying the phone number as the one that will be used to dial into a teleconference. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API. enabledCallMe: type: boolean description: 'Flag to enable/disable Call Me number display on the meeting client. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API. ***Note***: This feature is only effective if the site supports the ***Call Me*** feature.' description: Mobile phone number. We recommend that phone numbers be specified to facilitate connecting via audio. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API. description: 'Audio Preferences. ***Note***: These audio settings do not apply to Personal Room meetings' video: type: object required: - videoDevices properties: videoDevices: type: array items: type: object required: - deviceName - deviceAddress - isDefault properties: deviceName: type: string example: device1 description: Video system name. It cannot be empty. This attribute can be modified with the [Update Video Options](/docs/api/v1/meeting-preferences/update-video-options) API. deviceAddress: type: string example: device1@example.com description: Video address. It cannot be empty and must be in valid email format. This attribute can be modified with the [Update Video Options](/docs/api/v1/meeting-preferences/update-video-options) API. isDefault: type: boolean example: true description: 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 with the [Update Video Options](/docs/api/v1/meeting-preferences/update-video-options) API. description: Array of video devices. This attribute can be modified with the [Update Video Options](/docs/api/v1/meeting-preferences/update-video-options) API. description: 'Information for video conferencing systems used to connect to Webex meetings. ***Note***: The ***Call My Video System*** feature is available only if it has been purchased for your site and your administrator has enabled it.' schedulingOptions: $ref: '#/components/schemas/SchedulingOptionsObject' description: Meeting scheduling options. sites: type: array items: type: object required: - siteUrl - default properties: siteUrl: type: string example: site1-example.webex.com description: 'Access URL for the site. ***Note***: This is a read-only attribute. The value can be assigned as user''s default site with the [Update Default Site](/docs/api/v1/meeting-preferences/update-default-site) API.' default: type: boolean description: Flag identifying the site as the default site. Users can list meetings and recordings, and create meetings on the default site. description: List of user's Webex meeting sites including default site. UpdatePMRObject: type: object required: - topic - hostPin - enabledAutoLock - autoLockMinutes - enabledNotifyHost - supportCoHost - coHosts properties: topic: type: string example: John's PMR description: Personal Meeting Room topic to be updated. hostPin: type: string example: '4325' description: Updated PIN for joining the room as host. The host PIN must be digits of a predefined length, e.g. 4 digits. It cannot contain sequential digits, such as 1234 or 4321, or repeated digits of the predefined length, such as 1111. The predefined length for host PIN can be viewed in user's `My Personal Room` page and it can only be changed by site administrator. enabledAutoLock: type: boolean description: Update for option to automatically lock the Personal Room a number of minutes after a meeting starts. When a room is locked, invitees cannot enter until the owner admits them. The period after which the meeting is locked is defined by `autoLockMinutes`. autoLockMinutes: type: number description: Updated number of minutes after which the Personal Room is locked if `enabledAutoLock` is enabled. Valid options are 0, 5, 10, 15 and 20. enabledNotifyHost: type: boolean example: true description: Update for flag to enable notifying the owner of a Personal Room when someone enters the Personal Room lobby while the owner is not in the room. supportCoHost: type: boolean example: true description: Update for flag allowing other invitees to host a meetingCoHost in the Personal Room without the owner. supportAnyoneAsCoHost: type: boolean description: Whether or not to allow any attendee with a host account on the target site to become a cohost when joining the Personal Room. The target site is user's preferred site. allowFirstUserToBeCoHost: type: boolean description: Whether or not to allow the first attendee with a host account on the target site to become a cohost when joining the Personal Room. The target site is user's preferred site. allowAuthenticatedDevices: type: boolean description: Whether or not to allow authenticated video devices in the user's organization to start or join the meeting without a prompt. coHosts: type: array items: type: object required: - email - displayName properties: email: type: string example: john.andersen@example.com description: Email address for cohost. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API. displayName: type: string example: John Andersen description: Display name for cohost. This attribute can be modified with the [Update Personal Meeting Room Options](/docs/api/v1/meeting-preferences/update-personal-meeting-room-options) API. description: Updated array defining cohosts for the room if both `supportAnyoneAsCoHost` and `allowFirstUserToBeCoHost` are `false` AudioObject: type: object required: - defaultAudioType - otherTeleconferenceDescription - enabledGlobalCallIn - enabledTollFree - enabledAutoConnection - officeNumber - mobileNumber properties: defaultAudioType: type: string enum: - webexAudio - voipOnly - otherTeleconferenceService - none description: "Default audio type. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API.\n * `webexAudio` - Webex audio. This supports telephony and VoIP.\n * `voipOnly` - Support only VoIP.\n * `otherTeleconferenceService` - Other teleconference service. Details are defined in the `otherTeleconferenceDescription` parameter.\n * `none` - No audio.\n" otherTeleconferenceDescription: type: string description: Phone number and other information for the teleconference provider to be used, along with instructions for invitees. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API. enabledGlobalCallIn: type: boolean description: 'Flag to enable/disable global call ins. ***Note***: If the site does not support global call-ins, you cannot set this option. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API.' enabledTollFree: type: boolean description: 'Flag to enable/disable call-ins from toll-free numbers. ***Note***: If the site does not support calls from toll-free numbers, you cannot set this option. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API.' enabledAutoConnection: type: boolean description: Flag to enable/disable automatically connecting to audio using a computer. The meeting host can enable/disable this option. When this option is set to `true`, the user is automatically connected to audio via a computer when they start or join a Webex Meetings meeting on a desktop. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API. audioPin: type: string description: PIN to provide a secondary level of authentication for calls where the host is using the phone and may need to invite additional invitees. It must be exactly 4 digits. It cannot contain sequential digits, such as 1234 or 4321, or repeat a digit 4 times, such as 1111. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API. officeNumber: type: object required: - countryCode - number - enabledCallInAuthentication - enabledCallMe properties: countryCode: type: string description: Country code for the phone number. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API. number: type: string description: Phone number. It cannot be longer than 30 characters. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API. enabledCallInAuthentication: type: boolean description: Flag identifying the phone number as the one that will be used to dial into a teleconference. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API. enabledCallMe: type: boolean description: 'Flag to enable/disable Call Me number display on the meeting client. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API. ***Note***: This feature is only effective if the site supports the ***Call Me*** feature.' description: Office phone number. We recommend that phone numbers be specified to facilitate connecting via audio. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API. mobileNumber: type: object required: - countryCode - number - enabledCallInAuthentication - enabledCallMe properties: countryCode: type: string description: Country code for the phone number. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API. number: type: string description: Phone number. It cannot be longer than 30 characters. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API. enabledCallInAuthentication: type: boolean description: Flag identifying the phone number as the one that will be used to dial into a teleconference. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API. enabledCallMe: type: boolean description: 'Flag to enable/disable Call Me number display on the meeting client. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API. ***Note***: This feature is only effective if the site supports the ***Call Me*** feature.' description: Mobile phone number. We recommend that phone numbers be specified to facilitate connecting via audio. This attribute can be modified with the with the [Update Audio Options](/docs/api/v1/meeting-preferences/update-audio-options) API. BatchRefreshPMRIDObject: type: object required: - siteUrl properties: siteUrl: type: string example: example.webex.com description: Site URL to refresh the personal room IDs. personalMeetingRoomIds: type: array items: $ref: '#/components/schemas/PMRIDObject' description: Information of whose personal room IDs are to be refreshed and how to refresh. The maximum size of `items` is 100. DefaultSiteObject: type: object required: - siteUrl properties: siteUrl: type: string example: site1-example.webex.com description: Access URL for the site. BatchRefreshPMRIDResponseObject: type: object properties: siteUrl: type: string example: example.webex.com description: URL of the Webex site. personalMeetingRoomIds: type: array items: $ref: '#/components/schemas/PMRIDResponseObject' description: Information for the refreshed personal room IDs. SiteObject: type: object required: - siteUrl - default properties: siteUrl: type: string example: site1-example.webex.com description: 'Access URL for the site. ***Note***: This is a read-only attribute. The value can be assigned as user''s default site with the [Update Default Site](/docs/api/v1/meeting-preferences/update-default-site) API.' default: type: boolean description: Flag identifying the site as the default site. Users can list meetings and recordings, and create meetings on the default site. SchedulingOptionsDelegateEmailsObject: type: object properties: emails: type: array items: type: string example: marcus.hoffmann@example.com, brenda.song@example.com description: You can allow other hosts to schedule meetings on your behalf by entering their email addresses here. This attribute can be modified with the [Update Scheduling Options](/docs/api/v1/meeting-preferences/update-scheduling-options), [Insert Delegate Emails](/docs/api/v1/meeting-preferences/insert-delegate-emails), and [Update Scheduling Options](/docs/api/v1/meeting-preferences/delete-delegate-emails) APIs. securitySchemes: oauth2: flows: authorizationCode: authorizationUrl: / scopes: {} tokenUrl: / type: oauth2 bearer-key: type: http description: e.g. Bearer YOUR_AUTHORIZATION_TOKEN scheme: bearer bearerFormat: JWT bearerAuth: type: oauth2 description: OAuth 2.0 Bearer token authentication flows: authorizationCode: authorizationUrl: https://webexapis.com/v1/authorize tokenUrl: https://webexapis.com/v1/access_token scopes: spark:applications_token: Create access tokens for Service Apps