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 GroupsRolesSession 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 ReportVideo 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 ReportRecordingsSession 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
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 TabsRoomsSession 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

Update User Tracking Codes

Updates tracking codes for a specified user by an admin user.

  • The siteUrl is required. The operation updates a user's tracking code on the specified site. All a user's available Webex sites can be retrieved by the Get Site List API. Please note that the user here is the admin user who invokes the API, not the user specified by personId or email.

  • A name that is not found in the site-level tracking codes cannot be set for a user's tracking codes. All available site-level tracking codes for a site can be retrieved by the List Tracking Codes API.

  • If the inputMode of a user's tracking code is select or hostProfileSelect, its value must be one of the site-level options of that tracking code. All available site-level tracking codes for a site can be retrieved by the List Tracking Codes API.

PUT/v1/admin/meeting/userconfig/trackingCodes
Body Parameters
siteUrl
stringrequired

Site URL for the tracking code.

personId
string

Unique identifier for the user. At least one parameter of personId or email is required. personId must precede email if both are specified.

email
string

Email address for the user. At least one parameter of personId or email is required. personId must precede email if both are specified.

trackingCodes
array[UpdateTrackingCodeItemForUserObject]

Tracking code information for updates.

name
stringrequired

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

value
stringrequired

Value for tracking code. value cannot be empty and the maximum size is 120 characters.

Response Properties
siteUrl
string

Site URL for the tracking code.

personId
string

Unique identifier for the user.

email
string

Email address for the user.

trackingCodes
array[GetTrackingCodeItemForUserObject]

Tracking code information.

id
string

Unique identifier for tracking code.

name
string

Name for tracking code.

value
string

Value for tracking code.

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
PUT
/v1/admin/meeting/userconfig/trackingCodes
Log in to try the API.
Header
Body
  • Site URL for the tracking code.
  • Unique identifier for the user. At least one parameter of `personId` or `email` is required. `personId` must precede `email` if both are specified.
  • Email address for the user. At least one parameter of `personId` or `email` is required. `personId` must precede `email` if both are specified.
  • Tracking code information for updates.
  • Request
  • Response
{
    "personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xOGJiOWNjMC0zMWM2LTQ3MzYtYmE4OC0wMDk5ZmQzNDNmODE",
    "email": "john.andersen@example.com",
    "siteUrl": "example.webex.com",
    "trackingCodes": [
        {
            "name": "Department",
            "value": "Sales"
        },
        {
            "name": "Division",
            "value": "Part-time"
        }
    ]
}
200 / OK
{
    "personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xOGJiOWNjMC0zMWM2LTQ3MzYtYmE4OC0wMDk5ZmQzNDNmODE",
    "email": "john.andersen@example.com",
    "siteUrl": "example.webex.com",
    "trackingCodes": [
        {
            "id": 1,
            "name": "Department",
            "value": "Sales"
        },
        {
            "id": 2,
            "name": "Division",
            "value": "Part-time"
        }
    ]
}

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.