Webex · Schema

SitesObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
sites array 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 [Upda
View JSON Schema on GitHub

JSON Schema

webex-sitesobject-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SitesObject",
  "title": "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."
    }
  }
}