Cvent Event Cloud Webcasts API

openapi: 3.2.0
info:
  title: Cvent REST APIs — Event Cloud Webcasts API
  description: "Event Cloud scope of the Cvent REST APIs. This document is a TAG-SCOPED SUBSET of the OpenAPI specification Cvent publishes at https://github.com/cvent/rest-sdks/blob/main/cvent-public-spec/openapi.yaml (the source of truth for Cvent's official TypeScript/.NET/Java SDKs). Venue-sourcing, RFP, housing-supplier and travel-supplier tags were removed because they belong to Cvent Hospitality Cloud; every path, operation, parameter, schema and security requirement below is verbatim from Cvent's published spec.\n\n# Introduction\nThe Cvent API Platform is built around REST. We aim to provide intuitive endpoints that can be easily\ndiscovered to help leverage the Cvent platform for your event needs. The RESTful APIs outlined here\nuse JSON-encoded request and response format, along with HTTP codes, to convey processing status of\nrequests received. The Cvent resources are protected using OAuth2.\n\n# Getting Started\n\nIf you're new to the Cvent API Platform, start by reading our\n[Developer Quickstart](https://developers.cvent.com/docs/rest-api/tutorials/developer-quickstart) guide. This will\ngive you an overview of how to authenticate and make requests using our APIs.\n\n## Authentication\n\nThe Cvent REST API uses [OAuth2](https://oauth.net/2/) to authorize requests to the platform. The client\ncredentials authorization flow is supported.\n\n<a name=\"oauth2-auth-code-planner-admin\"></a>\n\nAuthorization code flow is only supported for planner users with the administrator role in Cvent. Developer users\ncannot use authorization code flow.\n\n<!-- ReDoc-Inject: <security-definitions> -->\n\nHere's an example of using client credential flow to authorize. You'll supply your application's id and secret to\nmake a [Token](#operation/oauth2Token) request.\n\n```bash\ncurl --location --request POST '{hostName}/{version}/oauth2/token' \\\n--header 'Content-Type: application/x-www-form-urlencoded' \\\n--header 'Authorization: Basic {api_credentials}' \\\n--data-urlencode 'grant_type=client_credentials' \\\n--data-urlencode 'client_id={client_id}'\n```\n\n| Key               | Description                                          | Value                                                                                                        |\n| :---------------- | :--------------------------------------------------- | :----------------------------------------------------------------------------------------------------------- |\n| {hostName}        | https://api-platform.cvent.com                       | Location if your account is in the North American datacenter.                                                |\n|                   | https://api-platform-eur.cvent.com                   | Location if your account is in the European data center.                                                     |\n| {version}         | ea                                                   | The version of the API you're using. Only `ea` is currently supported.                                       |\n| {api_credentials} | {client_id}:{client_secret} in base64 encoded format | Supply your client id & client credentials in a base 64 encoded format.                                      |\n| {client_id}       | Retrieved from your application                      | Your application's client id.                                                                                |\n| {client_secret}   | Retrieved from your application                      | Your application's client secret.                                                                            |\n\nOn a successful call, you'll receive the following response:\n\n```json\n{\n  \"access_token\": \"{accessToken}\",\n  \"expires_in\": 3600,\n  \"token_type\": \"Bearer\"\n}\n```\n\nThis bearer token is valid for 3600 seconds (60 minutes) and must be used in subsequent calls.\n\n## Endpoints\n\nEndpoints start with `hostName` and `version`.\n\nThe `hostname` will depend on the region that your Cvent account is hosted in. Please see the table\nbelow to identify which hostname you should be using.\n\n| Region        |\tHostname                           |\n|:--------------|:-----------------------------------|\n| North America\t| https://api-platform.cvent.com     |\n| Europe        | https://api-platform-eur.cvent.com |\n\nThe current `version` of the Cvent API is `ea`.\n\n## Rate Limits\n\nCvent APIs enforce rate limits to ensure platform stability. Your limits depend on your tier: Free,\nStandard, or Premium.\n\n<br />\n\n### Usage Tiers\n\n| Tier     | Daily Calls | Calls per Second | Max Burst |\n| -------- | ----------- | ---------------- | --------- |\n| Free     | 1,000       | 2                | 1         |\n| Standard | 15,000      | 10               | 10        |\n| Premium  | 500,000     | 25               | 25        |\n\n- **Daily calls** define how many requests you can make in a 24-hour period. Quota\n  resets at 12 midnight (+0 GMT).\n- **Calls per second** define how many requests you can make in a 1-second window.\n- **Max Burst** defines how many requests you can make at once.\n\nIf you are unsure what usage tier applies to your account, you can check via\n[Get Current Usage Tier](#operation/getUsageTier).\n\nPlease note that these limits may change as the Cvent API Platform evolves.\n\n<br />\n\n### Handling Rate Limits\n\nSometimes, you may exceed your rate limits. When this happens, the API will return a `429 Too Many Requests`. See\n[handling rate limits](https://developers.cvent.com/docs/rest-api/guides/handling-rate-limits) for best practices on how to handle this.\n\n## Pagination\n\nSome APIs use pagination to manage records. Each page of records has a token associated to identify it.\n\nIf an API uses pagination, you’ll find up to three tokens in the response:\n- **currentToken**: Describes the token of the current page.\n- **nextToken**: Provides a token for the next page of records, if one exists.\n- **previousToken**: Provides a token for the previous page of records, if one exists. Not all APIs will return\n  this token.\n\nYou specify which page of records to view via the `token` parameter in your API call. To navigate through pages,\ntake the `nextToken` or `previousToken` value and pass it to your next call’s `token` parameter to get the\nrespective page of records. For example, if you made this request:\n\n```bash\ncurl -X GET {hostname}/{version}/contacts?limit=100 \\\n-H 'Accept: application/json' \\\n-H 'Authorization: Bearer {accessToken}'\n```\n\nThe response contains a paging array where you'll find the token information.\n\n```json\n{\n  \"paging\": {\n    \"currentToken\": \"90c5f062-76ad-4ea4-aa53-00eb698d9262\",\n    \"nextToken\": \"3b2359a7-4583-40ed-8afd-67e5f15373d3\",\n    \"limit\": 100,\n    \"totalCount\": 102,\n    \"_links\": {...}\n  },\n  \"data\": [...]\n}\n```\n\nTake the `nextToken` and use it in the `token` parameter on your subsequent call.\n\n```bash\ncurl -X GET {hostname}/{version}/contacts?limit=100&token=3b2359a7-4583-40ed-8afd-67e5f15373d3 \\\n-H 'Accept: application/json' \\\n-H 'Authorization: Bearer {accessToken}'\n```\n\nWhen the response doesn’t contain a `nextToken` field, you’ve reached the last page. Occasionally, you might\nencounter an empty page at the end of results. This typically happens when the results were evenly divisible.\nEnsure your client code handles the possibility of receiving an empty data array when using the `nextToken`.\n\n## Filtering\n\nUse filters to narrow down results. The filter follows the pattern\n`filter='field' comparisonType 'value'`. The value can be enclosed with single\nquotes (') or double quotes (\").\n\n```bash\nGET {hostName}/{version}/contacts?filter=lastName eq 'Smith'\n````\n\nTo correctly pass a single quote in the filter's value, use double quotes around\nthe string.\n\n```bash\nGET {hostName}/{version}/contacts?filter=lastName eq \"O'Keenan\"\n```\n\nTo correctly pass a double quote in the filter's value, use double quotes around\nthe string and add an escape character `\\` to each quote that is part of the\nstring.\n\n```bash\nGET {hostName}/{version}/events?filter=eventName eq \"\\\"Yearly\\\" Conference\"\n```\n\n## Versioning\n\nChange is inevitable in API development. Planning for it is crucial. We track\nboth backward-compatible and backward-incompatible changes.\n\n<br />\n\n### Backward Compatible Changes\n\nBackward compatible changes will be made often and are intended to avoid\nany adverse impact on our customers. It is highly advisable that when reading\nJSON payloads from Cvent, you are able to handle \"unknown\" attributes that\ncan be added over time. We consider the following changes backward-compatible:\n\n- Adding new resources\n- Adding new optional request parameters to existing operations\n- Adding new attributes to requests or responses\n- Changing the length or format (not type) of resource identifiers. For example, an ID can change from\n  \"1234/1234\" to \"1234::1234\".\n- Increasing the length of string fields\n\n<br />\n\n### Backward Incompatible Changes\n\nBackward-incompatible changes are made infrequently, however, they can be\ndisruptive to consumers. Due to this, our APIs are versioned to avoid\ndisruptions to customers. We leverage a URI-based versioning scheme,\nwhich means that a version value is included in the Cvent API URL.\nWhen breaking changes occur, a new version of the API is made available\nwhile the existing version is deprecated but remains available for a\nlimited period of time. We consider the following backward-incompatible changes:\n\n- Adding a new required parameter (query string param or payload attribute)\n- Deleting API resources\n- Deleting any attribute from API responses\n- Changing the data type on any parameter or attribute\n\n## Standards\nAs you begin working with our APIs, it's essential to be aware of standards around\ncountry codes, time formats, and other important details that ensure smooth integration.\nLearn more about our [API Standards](https://developers.cvent.com/docs/rest-api/reference/api-standards)\n"
  contact:
    name: Cvent Development Platform
    url: https://developers.cvent.com/
  version: ea
servers:
- url: https://api-platform.cvent.com/ea
- url: https://api-platform-eur.cvent.com/ea
tags:
- name: Webcasts
  description: Webcasts are virtual or livestreaming components of your Cvent events. Use these APIs to integrate your virtual events from outside sources into your Cvent workflows, create and delete webcasts from within Cvent, and retrieve and update webcast details.
paths:
  /webcasts:
    post:
      tags:
      - Webcasts
      operationId: createWebcast
      security:
      - OAuth2.clientCredentials:
        - event/webcasts:write
      - OAuth2.authorizationCode:
        - event/webcasts:write
      summary: Create Webcast
      description: Used to create a new webcast for a specific event.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/webcast'
        required: true
      responses:
        '200':
          description: Webcast was successfully integrated for specific event.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/existing-webcast'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '409':
          $ref: '#/components/responses/Conflict1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      deprecated: false
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    get:
      security:
      - OAuth2.clientCredentials:
        - event/webcasts:read
      - OAuth2.authorizationCode:
        - event/webcasts:read
      summary: List Webcasts
      description: Gets a paginated list of webcasts associated with your event.
      operationId: listWebcasts
      parameters:
      - $ref: '#/components/parameters/after'
      - $ref: '#/components/parameters/before'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/token'
      - name: filter
        in: query
        required: false
        description: 'Use filter query parameters to limit results

          to data that matches your criteria. See

          [Filters](https://developers.cvent.com/docs/rest-api/reference/filters) for details.


          Supported fields and operators are listed below:


          | Field          | Operators                                |

          |----------------|------------------------------------------|

          | id             | `eq`, `ne`                               |

          | event.id       | `eq`, `ne`                               |

          | session.id     | `eq`, `ne`, `is empty`, `is not empty`   |

          | appointment.id | `eq`, `ne`, `is empty`, `is not empty`   |

          | exhibitor.id   | `eq`, `ne`, `is empty`, `is not empty`   |

          | sourceId       | `eq`, `ne`, `is empty`, `is not empty`   |

          | solutionType   | `eq`, `ne`                               |

          | provider       | `eq`, `ne`                               |

          | type           | `eq`, `ne`                               |

          | status         | `eq`, `ne`                               |

          | meetingId      | `eq`, `ne`                               |

          | created        | `eq`, `ne`, `lt`, `le`, `gt`, `ge`       |

          | lastModified   | `eq`, `ne`, `lt`, `le`, `gt`, `ge`       |

          | playerType     | `eq`, `ne`                               |

          '
        schema:
          type: string
          example: event.id eq '04ca6ae2-0dc3-487b-953e-86d6abbdf7d3' and sourceId ne 'sampleWebcastSystemId'
      tags:
      - Webcasts
      responses:
        '200':
          description: Successfully retrieved a paginated list of webcasts.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/webcast-paginated-response'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      deprecated: false
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
  /webcasts/attendee-links:
    get:
      security:
      - OAuth2.clientCredentials:
        - event/attendee-links:read
      - OAuth2.authorizationCode:
        - event/attendee-links:read
      summary: List Attendee Links
      description: Gets a paginated list of attendee links.
      operationId: listAttendeeLinks
      parameters:
      - $ref: '#/components/parameters/after'
      - $ref: '#/components/parameters/before'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/token'
      - name: filter
        in: query
        required: false
        description: 'Use filter query parameters to limit results

          to data that matches your criteria. See

          [Filters](https://developers.cvent.com/docs/rest-api/reference/filters) for details.


          Supported fields and operators are listed below:


          | Field        | Operators                          |

          |--------------| -----------------------------------|

          | id           | `eq`, `ne`                         |

          | sourceId     | `eq`, `ne`                         |

          | attendee.id  | `eq`, `ne`                         |

          | webcast.id   | `eq`, `ne`                         |

          | created      | `eq`, `ne`, `lt`, `le`, `gt`, `ge` |

          | lastModified | `eq`, `ne`, `lt`, `le`, `gt`, `ge` |

          '
        schema:
          type: string
          example: id eq '04ca6ae2-0dc3-487b-953e-86d6abbdf7d3' and event.id eq '55ca6645-0dc3-487b-953e-86d6abbdf7d3'
      tags:
      - Webcasts
      responses:
        '200':
          description: Successfully retrieved a paginated list of attendee links.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/attendee-link-paginated-response'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      deprecated: false
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
  /webcasts/players:
    get:
      security:
      - OAuth2.clientCredentials:
        - event/players:read
      - OAuth2.authorizationCode:
        - event/players:read
      summary: List Players
      description: Gets a paginated list of player details associated with webcast.
      operationId: listPlayers
      parameters:
      - $ref: '#/components/parameters/after'
      - $ref: '#/components/parameters/before'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/token'
      - name: filter
        in: query
        required: false
        description: 'Use filter query parameters to limit results

          to data that matches your criteria. See

          [Filters](https://developers.cvent.com/docs/rest-api/reference/filters) for details.


          Supported fields and operators are listed below:


          | Field        | Operators                          |

          |--------------| -----------------------------------|

          | webcast.id   | `eq`, `ne`                         |

          | id           | `eq`, `ne`                         |

          | created      | `eq`, `ne`, `lt`, `le`, `gt`, `ge` |

          | lastModified | `eq`, `ne`, `lt`, `le`, `gt`, `ge` |

          '
        schema:
          type: string
          example: webcast.id eq '04ca6ae2-0dc3-487b-953e-86d6abbdf7d3'
      tags:
      - Webcasts
      responses:
        '200':
          description: Successfully retrieved a paginated list of players.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/player-paginated-response'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      deprecated: false
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
  /webcasts/{id}:
    parameters:
    - $ref: '#/components/parameters/id13'
    get:
      summary: Get Webcast
      description: Retrieve a single webcast details by ID.
      operationId: getWebcastById
      security:
      - OAuth2.clientCredentials:
        - event/webcasts:read
      - OAuth2.authorizationCode:
        - event/webcasts:read
      tags:
      - Webcasts
      responses:
        '200':
          description: Successfully retrieved a webcast object.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/existing-webcast'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '404':
          $ref: '#/components/responses/NotFound1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      deprecated: false
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    delete:
      summary: Delete Webcast
      description: Delete an existing webcast by ID.
      operationId: deleteWebcast
      security:
      - OAuth2.clientCredentials:
        - event/webcasts:delete
      - OAuth2.authorizationCode:
        - event/webcasts:delete
      tags:
      - Webcasts
      responses:
        '204':
          description: Successfully deleted webcast from specific event.
          headers: {}
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '404':
          $ref: '#/components/responses/NotFound1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      deprecated: false
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    put:
      tags:
      - Webcasts
      operationId: updateWebcast
      security:
      - OAuth2.clientCredentials:
        - event/webcasts:write
      - OAuth2.authorizationCode:
        - event/webcasts:write
      summary: Update Webcast
      description: Update info for an existing webcast within a Cvent event.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/existing-webcast'
        required: true
      responses:
        '200':
          description: Webcast was successfully updated for specific event.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/existing-webcast'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '404':
          $ref: '#/components/responses/NotFound1'
        '409':
          $ref: '#/components/responses/Conflict1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      deprecated: false
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
  /webcasts/{id}/attendee-links:
    parameters:
    - $ref: '#/components/parameters/id13'
    post:
      tags:
      - Webcasts
      operationId: createAttendeeLinks
      security:
      - OAuth2.clientCredentials:
        - event/attendee-links:write
      - OAuth2.authorizationCode:
        - event/attendee-links:write
      summary: Create Attendee Link
      description: Create attendee links in bulk for a given webcast.
      requestBody:
        description: Up to **100 attendee links** can be created per call.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bulk-attendee-link'
        required: true
      responses:
        '207':
          description: Attendee links successfully created.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/attendee-link-bulk-response'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '404':
          $ref: '#/components/responses/NotFound1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      deprecated: false
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    put:
      tags:
      - Webcasts
      operationId: updateAttendeeLinks
      security:
      - OAuth2.clientCredentials:
        - event/attendee-links:write
      - OAuth2.authorizationCode:
        - event/attendee-links:write
      summary: Update Attendee Link
      description: Update data for existing attendee links in bulk for a given webcast.
      requestBody:
        description: Up to **100 attendee links** can be updated per call.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bulk-existing-attendee-link'
        required: true
      responses:
        '207':
          description: Attendee links successfully updated.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/attendee-link-bulk-response'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '404':
          $ref: '#/components/responses/NotFound1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      deprecated: false
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    get:
      security:
      - OAuth2.clientCredentials:
        - event/attendee-links:read
      - OAuth2.authorizationCode:
        - event/attendee-links:read
      summary: List Attendee Links
      description: Gets a paginated list of attendee links in a webcast.
      operationId: listWebcastAttendeeLinks
      parameters:
      - $ref: '#/components/parameters/after'
      - $ref: '#/components/parameters/before'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/token'
      - name: filter
        in: query
        required: false
        description: 'Use filter query parameters to limit results

          to data that matches your criteria. See

          [Filters](https://developers.cvent.com/docs/rest-api/reference/filters) for details.


          Supported fields and operators are listed below:


          | Field        | Operators                          |

          |--------------| -----------------------------------|

          | id           | `eq`, `ne`                         |

          | sourceId     | `eq`, `ne`                         |

          | attendee.id  | `eq`, `ne`                         |

          | created      | `eq`, `ne`, `lt`, `le`, `gt`, `ge` |

          | lastModified | `eq`, `ne`, `lt`, `le`, `gt`, `ge` |

          '
        schema:
          type: string
          example: id eq '04ca6ae2-0dc3-487b-953e-86d6abbdf7d3'
      tags:
      - Webcasts
      responses:
        '200':
          description: Successfully retrieved a paginated list of attendee links.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/attendee-link-paginated-response'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '404':
          $ref: '#/components/responses/NotFound1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      deprecated: true
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
  /webcasts/{id}/attendee-links/{attendeeLinkId}:
    parameters:
    - $ref: '#/components/parameters/id13'
    - $ref: '#/components/parameters/attendeeLinkId'
    delete:
      summary: Delete Attendee Link
      description: Delete attendee links for webcast.
      operationId: deleteAttendeeLink
      security:
      - OAuth2.clientCredentials:
        - event/attendee-links:delete
      - OAuth2.authorizationCode:
        - event/attendee-links:delete
      tags:
      - Webcasts
      responses:
        '204':
          description: Successfully deleted webcast attendee link from specific event.
          headers: {}
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '404':
          $ref: '#/components/responses/NotFound1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      deprecated: false
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
components:
  schemas:
    webcast-type.json:
      title: WebcastType
      enum:
      - Meeting
      - Webinar
      - Presentation
      type: string
      description: This is used to denote the type of a webcast
      example: Meeting
    region.json1:
      title: Region
      enum:
      - Oregon
      - Virginia
      - Tokyo
      - Singapore
      - Sydney
      - Mumbai
      - Frankfurt
      - Ireland
      type: string
      description: Region where the live stream originates (These regions are only for Brightcove player)
      example: Oregon
    uuid-property:
      title: UUID Property
      description: A string that has to be a format matching the industry standard uuid
      type: string
      format: uuid
      example: 04ca6ae2-0dc3-487b-953e-86d6abbdf7d3
    paging.json:
      title: Paging
      required:
      - _links
      type: object
      description: Represents pagination information for a collection of resources.
      properties:
        previousToken:
          type: string
          description: The pagination token for the previous page, if one exists. You can use this token to navigate to the previous page of data.
          example: 1a2b3c4d5e6f7g8h9i10j11k
        nextToken:
          type: string
          description: The pagination token for the next page. If this value is present in the response, there is another page of data you can fetch.
          example: 1a2b3c4d5e6f7g8h9i10j11k
        currentToken:
          type: string
          description: The pagination token for the current page.
          example: 1a2b3c4d5e6f7g8h9i10j11k
        limit:
          type: integer
          description: The number of records to return on the page. Not to exceed 200.
          example: 100
        totalCount:
          type: integer
          description: The total number of records available. This field may return blank, even if there are more records. To confirm if there are more records, check the `nextToken` field.
          example: 2
        _links:
          $ref: '#/components/schemas/pagination-links.json'
    webcast-host-link.json:
      title: WebcastHostLink
      description: Link details for a webcast host.
      type: object
      properties:
        href:
          type: string
          description: A url to the webcast.
          maxLength: 2000
          example: https://cvent.zoom.us/j/7566652259
        code:
          type: string
          description: Access code of webcast link.
          maxLength: 100
          example: 1456ZS78
        key:
          type: string
          description: Host key for the webcast.
          maxLength: 100
          example: abcd1234
    format.json:
      title: Format
      enum:
      - Live
      - Pre-recorded
      type: string
      default: Live
      description: This is used to denote the format of a webcast
      example: Pre-recorded
    link.json:
      title: Link
      required:
      - href
      type: object
      description: Represents a link to a related resource.
      properties:
        href:
          type: string
          description: A url provided that can be followed for linking
          example: ?token=90c5f062-76ad-4ea4-aa53-00eb698d9262
    error-response:
      title: ErrorResponse
      description: Represents an error response with additional details of cascading error messages.
      allOf:
      - title: ErrorResponseBase
        type: object
        description: Represents an error response with no additional details.
        required:
        - code
        - message
        properties:
          code:
            type: integer
            description: The HTTP status code representing the error.
            example: 400
          message:
            type: string
            description: A brief description of the error.
          

# --- truncated at 32 KB (94 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cvent-event-cloud/refs/heads/main/openapi/cvent-event-cloud-webcasts-api-openapi.yml