Session Types - Update User Session Types

Update User Session Types

Assign session types to specific users.

At least one of the following body parameters is required to update a specific user session type: personId, email.

PUT/v1/admin/meeting/userconfig/sessionTypes

Body Parameters

siteUrl

stringrequired

Site URL for the session type.

personId

string

A unique identifier for the user.

string

The email of the user.

sessionTypeIds

array[string]required

An array of the session type ID.

Possible values: 3, 9

Response Properties

personId

string

A unique identifier for the user.

string

The email of the user.

siteUrl

string

Site URL for the user.

sessionTypes

array[SessionType]

All session types are supported by the user on the site.

string

The ID of the session type.

shortName

string

The short name of the session type.

name

string

The name of the session type.

type

enum

The meeting type of meeting that you can create with the session type.

meeting

string

Meeting Center.

webinar

string

Webinar meeting.

privateMeeting

string

Private meeting.

EventCenter

string

Event Center.

SupportCenter

string

Support Center.

TrainCenter

string

Training Center.

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.

PUT

/v1/admin/meeting/userconfig/sessionTypes

Header

Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Body

siteUrl
stringRequired
Site URL for the session type.
personId
string
A unique identifier for the user.
email
string
The email of the user.
sessionTypeIds
arrayRequired
An array of the session type ID.

{
  "siteUrl": "example.webex.com",
  "personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8yNWJiZjgzMS01YmU5LTRjMjUtYjRiMC05YjU5MmM4YTA4NmI",
  "email": "john.andersen@example.com",
  "sessionTypeIds": [
    "3","9"
  ]
}

200 / OK

{
    "personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8yNWJiZjgzMS01YmU5LTRjMjUtYjRiMC05YjU5MmM4YTA4NmI",
    "email":"john.andersen@example.com",
    "siteUrl": "example.webex.com",
    "sessionTypes": [
        {
            "id": "3",
            "shortName": "PRO",
            "name": "Pro meeting",
            "type": "meeting"
        },
        {
            "id": "9",
            "shortName": "ONS",
            "name": "Online Event",
            "type": "EventCenter"
        }
    ]
}