openapi: 3.0.0
info:
  title: Webex Admin Address Book Session Types 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: Session Types
paths:
  /admin/meeting/config/sessionTypes:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json;charset=UTF-8:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/SiteSessionType'
                    description: An array of the site's session types.
              example:
                items:
                - id: '3'
                  shortName: PRO
                  siteUrl: example.webex.com
                  name: Pro meeting
                  type: meeting
                - id: '9'
                  shortName: ONS
                  siteUrl: example.webex.com
                  name: Online Event
                  type: EventCenter
        '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: List Site Session Types
      operationId: List Site Session Types
      description: List session types for a specific site.
      tags:
      - Session Types
      parameters:
      - 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: example.webex.com
        schema:
          type: string
  /admin/meeting/userconfig/sessionTypes:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json;charset=UTF-8:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/UserSessionTypes'
                    description: An array of the user's session types.
              example:
                items:
                - 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
        '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: List User Session Type
      operationId: List User Session Type
      description: List session types for a specific user.
      tags:
      - Session Types
      parameters:
      - name: siteUrl
        in: query
        description: URL of the Webex site to query.
        example: example.webex.com
        schema:
          type: string
      - name: personId
        in: query
        description: A unique identifier for the user.
        example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8yNWJiZjgzMS01YmU5LTRjMjUtYjRiMC05YjU5MmM4YTA4NmI
        schema:
          type: string
      - name: email
        in: header
        description: e.g. `john.andersen@example.com` (string, optional) - The email of the user.
        required: false
        schema:
          type: string
        example: '`john.andersen@example.com` (string, optional) - The email of the user.'
    put:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/UserSessionTypes'
              example:
                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
        '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: Update User Session Types
      operationId: Update User Session Types
      description: '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`.'
      tags:
      - Session Types
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUserSessionType'
components:
  schemas:
    SessionType:
      type: object
      properties:
        id:
          type: string
          example: '3'
          description: The ID of the session type.
        shortName:
          type: string
          example: PRO
          description: The short name of the session type.
        name:
          type: string
          example: Pro Meeting
          description: The name of the session type.
        type:
          type: string
          enum:
          - meeting
          - webinar
          - privateMeeting
          - EventCenter
          - SupportCenter
          - TrainCenter
          description: "The meeting type of meeting that you can create with the session type.\n * `meeting` - Meeting Center.\n * `webinar` - Webinar meeting.\n * `privateMeeting` - Private meeting.\n * `EventCenter` - Event Center.\n * `SupportCenter` - Support Center.\n * `TrainCenter` - Training Center.\n"
    UserSessionTypes:
      type: object
      properties:
        personId:
          type: string
          example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8yNWJiZjgzMS01YmU5LTRjMjUtYjRiMC05YjU5MmM4YTA4NmI
          description: A unique identifier for the user.
        email:
          type: string
          example: john.andersen@example.com
          description: The email of the user.
        siteUrl:
          type: string
          example: example.webex.com
          description: Site URL for the user.
        sessionTypes:
          type: array
          items:
            $ref: '#/components/schemas/SessionType'
          description: All session types are supported by the user on the site.
    UpdateUserSessionType:
      type: object
      required:
      - siteUrl
      - sessionTypeIds
      properties:
        siteUrl:
          type: string
          example: example.webex.com
          description: Site URL for the session type.
        personId:
          type: string
          example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8yNWJiZjgzMS01YmU5LTRjMjUtYjRiMC05YjU5MmM4YTA4NmI
          description: A unique identifier for the user.
        email:
          type: string
          example: john.andersen@example.com
          description: The email of the user.
        sessionTypeIds:
          type: array
          items:
            type: string
          example:
          - '3'
          - '9'
          description: An array of the session type ID.
    SiteSessionType:
      type: object
      properties:
        id:
          type: string
          example: '3'
          description: The ID of the session type.
        shortName:
          type: string
          example: PRO
          description: The short name of the session type.
        siteUrl:
          type: string
          example: example.webex.com
          description: Site URL for the session type.
        name:
          type: string
          example: Pro Meeting
          description: The name of the session type.
        type:
          type: string
          enum:
          - meeting
          - webinar
          - privateMeeting
          - EventCenter
          - SupportCenter
          - TrainCenter
          description: "The meeting type of meeting that you can create with the session type.\n * `meeting` - Meeting Center.\n * `webinar` - Webinar meeting.\n * `privateMeeting` - Private meeting.\n * `EventCenter` - Event Center.\n * `SupportCenter` - Support Center.\n * `TrainCenter` - Training Center.\n"
  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