Webex · Example Payload

Webex Create A Tracking Code Example

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Webex Create A Tracking Code Example is an example object payload from Webex, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

{
  "operationId": "Create a Tracking Code",
  "method": "POST",
  "path": "/admin/meeting/config/trackingCodes",
  "summary": "Create a Tracking Code",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "name": "Department",
        "siteUrl": "example.webex.com",
        "inputMode": "select",
        "options": [
          {
            "value": "Engineering",
            "defaultValue": false
          },
          {
            "value": "Design",
            "defaultValue": true
          },
          {
            "value": "Sales",
            "defaultValue": false
          }
        ],
        "hostProfileCode": "optional",
        "scheduleStartCodes": [
          {
            "service": "All",
            "type": "notApplicable"
          },
          {
            "service": "MeetingCenter",
            "type": "required"
          },
          {
            "service": "EventCenter",
            "type": "optional"
          },
          {
            "service": "TrainingCenter",
            "type": "notUsed"
          },
          {
            "service": "SupportCenter",
            "type": "notUsed"
          }
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "id": "1",
        "name": "Department",
        "siteUrl": "example.webex.com",
        "inputMode": "select",
        "options": [
          {
            "value": "Engineering",
            "defaultValue": false
          },
          {
            "value": "Design",
            "defaultValue": true
          },
          {
            "value": "Sales",
            "defaultValue": false
          }
        ],
        "hostProfileCode": "optional",
        "scheduleStartCodes": [
          {
            "service": "All",
            "type": "notApplicable"
          },
          {
            "service": "MeetingCenter",
            "type": "required"
          },
          {
            "service": "EventCenter",
            "type": "optional"
          },
          {
            "service": "TrainingCenter",
            "type": "notUsed"
          },
          {
            "service": "SupportCenter",
            "type": "notUsed"
          }
        ]
      }
    },
    {
      "status": "400",
      "contentType": "application/json;charset=UTF-8",
      "example": {
        "message": "The request could not be understood by the server due to malformed syntax. See 'errors' for more details.",
        "errors": [
          {
            "description": "'siteUrl' cannot be empty"
          }
        ],
        "trackingId": "92B0280B23E64C249456513AC7409D56_1661400232754"
      }
    }
  ]
}