Webex · Schema

CreateOrUpdateTrackingCodeObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
name	string	Name for tracking code. The name cannot be empty and the maximum size is 120 characters.
siteUrl	string	Site URL for the tracking code.
options	array	Tracking code option list. The maximum size of `options` is 500.
inputMode	string	Select an option for how users can provide a code value. Please note that if users set `inputMode` as `hostProfileSelect`, `scheduleStartCode` should be `null`, which means `hostProfileSelect` only ap
hostProfileCode	string	Type for the host profile. * `optional` - Available to be chosen but not compulsory. * `required` - Officially compulsory. * `adminSet` - The value is set by admin. * `notUsed` - The value cannot be u
scheduleStartCodes	array	Specify how tracking codes are used for each service on the meeting scheduler or meeting start pages. The maximum size of `scheduleStartCodes` is 5.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateOrUpdateTrackingCodeObject",
  "title": "CreateOrUpdateTrackingCodeObject",
  "type": "object",
  "required": [
    "name",
    "siteUrl",
    "options",
    "inputMode",
    "hostProfileCode",
    "scheduleStartCodes"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "Department",
      "description": "Name for tracking code. The name cannot be empty and the maximum size is 120 characters."
    },
    "siteUrl": {
      "type": "string",
      "example": "example.webex.com",
      "description": "Site URL for the tracking code."
    },
    "options": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OptionsForCreateOrUpdateTrackingCodeObject"
      },
      "description": "Tracking code option list. The maximum size of `options` is 500."
    },
    "inputMode": {
      "type": "string",
      "enum": [
        "text",
        "select",
        "editableSelect",
        "hostProfileSelect"
      ],
      "description": "Select an option for how users can provide a code value. Please note that if users set `inputMode` as `hostProfileSelect`, `scheduleStartCode` should be `null`, which means `hostProfileSelect` only applies to \"Host Profile\".\n * `text` - Text input.\n * `select` - Drop down list which requires `options`.\n * `editableSelect` - Both text input and select from list.\n * `hostProfileSelect` - An input method is only available for the host profile and sign-up pages.\n"
    },
    "hostProfileCode": {
      "type": "string",
      "enum": [
        "optional",
        "required",
        "adminSet",
        "notUsed"
      ],
      "description": "Type for the host profile.\n * `optional` - Available to be chosen but not compulsory.\n * `required` - Officially compulsory.\n * `adminSet` - The value is set by admin.\n * `notUsed` - The value cannot be used.\n"
    },
    "scheduleStartCodes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ScheduleStartCodeObject"
      },
      "description": "Specify how tracking codes are used for each service on the meeting scheduler or meeting start pages. The maximum size of `scheduleStartCodes` is 5."
    }
  }
}