Batch Refresh Personal Meeting Room ID
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.
Body Parameters
Site URL to refresh the personal room IDs.
Information of whose personal room IDs are to be refreshed and how to refresh. The maximum size of items is 100.
Email address of the meeting host whose personal room ID will be refreshed.
Unique identifier for the meeting host whose personal room ID will be refreshed.
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.
New personal room ID specified by the admin user.
Response Properties
URL of the Webex site.
Information for the refreshed personal room IDs.
Email address for the meeting host whose personal room ID has been refreshed.
Unique identifier for the meeting host whose personal room ID has been refreshed.
Refreshed personal room ID.
Response Codes
The list below describes the common success and error responses you should expect from the API:
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | 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 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | 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 | Gone | The requested resource is no longer available. |
| 415 | 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 | 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 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | 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 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Body
- Site URL to refresh the personal room IDs.
- Information of whose personal room IDs are to be refreshed and how to refresh. The maximum size of `items` is 100.
{
"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"
}
]
}
{
"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"
}
]
}