DocumentationBlogSupport
Log inSign up
Log inSign up
BlogSupport
Build
Getting StartedPlatform Introduction
Embedded Apps
OverviewDeveloper GuideSubmission Checklist for Embedded Apps
Design Guidelines
MeetingsMessagingDevices
API Reference
BotsButtons and CardsIntegrationsLogin with WebexWidgetsGuest IssuerWebex ConnectInstant Connect Meeting LinksDeveloper SandboxSubmit Your AppSupport PolicyFAQs
APIs
XML API DeprecationGetting StartedREST API BasicsComplianceWebhooksWebex APIs
Admin
OverviewAdmin APIsAuthentication
Guides
Hybrid ServicesWebhooksReal-time File DLP Basics
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting QualitiesOrganizationsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSecurity Audit EventsSession TypesSpace ClassificationsTracking Codes
GETList Tracking Codes
GETGet a Tracking Code
POSTCreate a Tracking Code
PUTUpdate a Tracking Code
DELETEDelete a Tracking Code
GETGet User Tracking Codes
PUTUpdate User Tracking Codes
Webex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Workspace SettingsWholesale Billing ReportsWorkspace LocationsWorkspace MetricsWorkspaces
Calling
Overview
Guides
Integrations and AuthorizationWebex for BroadWorksWebex for WholesaleWholesale and Broadworks Common Guide
Reference
BroadWorks Billing ReportsBroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks SubscribersCall ControlsLocationsPeopleRecording ReportSCIM2-GroupVideo MeshWebex Calling Detailed Call HistoryWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Voice MessagingWebex Calling Workspace SettingsWholesale Billing ReportsWholesale CustomersWholesale Subscribers
Contact Center
Overview
Devices
Overview
Guides
DevicesWorkspace Integrations Guide
Reference
Device ConfigurationsDevicesWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
Meetings
Overview
Guides
Integrations and AuthorizationWebhooksWebinar GuideMeeting Resource Guide
Reference
Meeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportPeopleRecording ReportRecordingsSCIM2-GroupSession TypesTracking Codes
GETList Tracking Codes
GETGet a Tracking Code
POSTCreate a Tracking Code
PUTUpdate a Tracking Code
DELETEDelete a Tracking Code
GETGet User Tracking Codes
PUTUpdate User Tracking Codes
Video MeshWebhooks
Messaging
Overview
Guides
BotsIntegrations and AuthorizationWebhooksButtons and Cards
Reference
Attachment ActionsEventsMembershipsMessagesPeopleRoom TabsRoomsTeam MembershipsTeamsTracking Codes
GETList Tracking Codes
GETGet a Tracking Code
POSTCreate a Tracking Code
PUTUpdate a Tracking Code
DELETEDelete a Tracking Code
GETGet User Tracking Codes
PUTUpdate User Tracking Codes
Webhooks
Webex Assistant Skills
Guides
Skills SDK GuideSkills Developer PortalSkills Reference GuideSkills UX Guide
Overview
FedRAMP
Overview
Guides
Create a BotCreate an IntegrationNotes on API Support
Webex Status API
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBroadWorks Billing ReportsBroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks SubscribersCall ControlsDevice ConfigurationsDevicesEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportMembershipsMessagesOrganizationsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesRoom TabsRoomsSCIM2-GroupSecurity Audit EventsSession TypesSiteSpace ClassificationsTeam MembershipsTeamsTracking Codes
GETList Tracking Codes
GETGet a Tracking Code
POSTCreate a Tracking Code
PUTUpdate a Tracking Code
DELETEDelete a Tracking Code
GETGet User Tracking Codes
PUTUpdate User Tracking Codes
Video MeshWebex Calling Detailed Call HistoryWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Voice MessagingWebex Calling Workspace SettingsWebhooksWholesale Billing ReportsWholesale CustomersWholesale SubscribersWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog
SDKs
iOSAndroidBrowserNode.jsJava
Developer CommunityCertifications

Create a Tracking Code

Create a new tracking code by an admin user.

  • The siteUrl is required. The operation creates a tracking code for the specified site. All or a user's available Webex sites can be retrieved by the Get Site List API.

  • The inputMode of hostProfileSelect is only available for a host profile and sign-up pages and does not apply to the meeting scheduler page or the meeting start page. The value for scheduleStartCodes must be null or the value for all services must be notUsed when the inputMode is hostProfileSelect.

  • The hostProfileCode of required is only allowed for a Site Admin managed site, and not for a Control Hub managed site.

  • When the hostProfileCode is adminSet, only adminSet, notUsed, and notApplicable are available for the types of scheduleStartCodes. When the hostProfileCode is not adminSet, only optional, required, notUsed, and notApplicable are available for scheduleStartCodes.

  • If the type of the All service has a value other than notApplicable, and another service, e.g. EventCenter, is missing from the scheduleStartCodes, then the type of this missing EventCenter service shares the same type as the All service. If the type of All service has a value other than notApplicable, and another service, e.g. EventCenter, has a type, then the type specified should be the same as the All service.

  • If the All service is missing from the scheduleStartCodes, any of the other four services, e.g. EventCenter, have a default type of notUsed if it is also missing from the scheduleStartCodes.

POST/v1/admin/meeting/config/trackingCodes
Body Parameters
name
stringrequired

Name for tracking code. The name cannot be empty and the maximum size is 120 characters.

siteUrl
stringrequired

Site URL for the tracking code.

options
array[OptionsForCreateOrUpdateTrackingCodeObject]required

Tracking code option list. The maximum size of options is 500.

value
stringrequired

The value of a tracking code option. value cannot be empty and the maximum size is 120 characters.

defaultValue
booleanrequired

Whether or not the option is the default option of a tracking code.

inputMode
enumrequired

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".

text
string

Text input.

select
string

Drop down list which requires options.

editableSelect
string

Both text input and select from list.

hostProfileSelect
string

An input method is only available for the host profile and sign-up pages.

hostProfileCode
enumrequired

Type for the host profile.

optional
string

Available to be chosen but not compulsory.

required
string

Officially compulsory.

adminSet
string

The value is set by admin.

notUsed
string

The value cannot be used.

scheduleStartCodes
array[ScheduleStartCodeObject]required

Specify how tracking codes are used for each service on the meeting scheduler or meeting start pages. The maximum size of scheduleStartCodes is 5.

service
enumrequired

Service for schedule or sign up pages

All
string

Tracking codes apply to all services.

MeetingCenter
string

Users can set tracking codes when scheduling a meeting.

EventCenter
string

Users can set tracking codes when scheduling an event.

TrainingCenter
string

Users can set tracking codes when scheduling a training session.

SupportCenter
string

Users can set tracking codes when scheduling a support meeting.

type
enumrequired

Type for meeting scheduler or meeting start pages.

optional
string

Available to be chosen but not compulsory.

required
string

Officially compulsory.

adminSet
string

The value is set by admin. This value only applies when hostProfileCode is adminSet.

notUsed
string

The value cannot be used.

notApplicable
string

This value only applies to the service of All. When the type of All for a tracking code is notApplicable, there are different types for different services. For example, required for MeetingCenter, optional for EventCenter and notUsed for others.

Response Properties
id
string

Unique identifier for tracking code.

name
string

Name for tracking code.

siteUrl
string

Site URL for the tracking code.

options
array[OptionsForTrackingCodeObject]

Tracking code option list.

value
string

The value of a tracking code option.

defaultValue
boolean

Whether or not the option is the default option of a tracking code.

inputMode
enum

An option for how an admin user can provide a code value.

text
string

Text input.

select
string

Drop down list which requires options.

editableSelect
string

Both text input and select from list.

hostProfileSelect
string

An input method is only available for the host profile and sign-up pages.

hostProfileCode
enum

Type for the host profile.

optional
string

Available to be chosen but not compulsory.

required
string

Officially compulsory.

adminSet
string

The value is set by admin.

notUsed
string

The value cannot be used.

scheduleStartCodes
array[ScheduleStartCodeObject]

Specify how tracking codes are used for each service on the meeting scheduler or meeting start pages.

service
enum

Service for schedule or sign up pages

All
string

Tracking codes apply to all services.

MeetingCenter
string

Users can set tracking codes when scheduling a meeting.

EventCenter
string

Users can set tracking codes when scheduling an event.

TrainingCenter
string

Users can set tracking codes when scheduling a training session.

SupportCenter
string

Users can set tracking codes when scheduling a support meeting.

type
enum

Type for meeting scheduler or meeting start pages.

optional
string

Available to be chosen but not compulsory.

required
string

Officially compulsory.

adminSet
string

The value is set by admin. This value only applies when hostProfileCode is adminSet.

notUsed
string

The value cannot be used.

notApplicable
string

This value only applies to the service of All. When the type of All for a tracking code is notApplicable, there are different types for different services. For example, required for MeetingCenter, optional for EventCenter and notUsed for others.

Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
201CreatedThe request has succeeded and has led to the creation of a resource.
202AcceptedThe request has been accepted for processing.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe 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.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe 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.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe 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.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo 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.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
  • Try it
  • Example
POST
/v1/admin/meeting/config/trackingCodes
Log in to try the API.
Header
Body
  • Name for tracking code. The name cannot be empty and the maximum size is 120 characters.
  • Site URL for the tracking code.
  • Tracking code option list. The maximum size of `options` is 500.
  • 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".
  • Type for the host profile.
  • Specify how tracking codes are used for each service on the meeting scheduler or meeting start pages. The maximum size of `scheduleStartCodes` is 5.
  • Request
  • Response
{
    "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"
        }
    ]
}
200 / OK
{
    "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"
        }
    ]
}

Connect

Support

Developer Events

Contact Sales

Handy Links

Webex Ambassadors

Webex App Hub

Resources

Open Source Bot Starter Kits

Download Webex

DevNet Learning Labs

Terms of Service

Privacy Policy

Cookie Policy

Trademarks

© 2023 Cisco and/or its affiliates. All rights reserved.