Update User Tracking Codes
Updates tracking codes for a specified user by an admin user.
The
siteUrlis 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 bypersonIdoremail.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
inputModeof a user's tracking code isselectorhostProfileSelect, 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.Admins can switch any Control Hub managed site from using classic tracking codes to mapped tracking codes in Control Hub, this is a one-time irreversible operation. Once the tracking codes are mapped to custom or user profile attributes, they cannot update user's tracking codes when the mapping process is in progress or the mapping process is completed.
Body Parameters
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.
Name for tracking code. The name cannot be empty and the maximum size is 120 characters.
Value for tracking code. value cannot be empty and the maximum size is 120 characters.
Response Properties
Site URL for the tracking code.
Unique identifier for the user.
Email address for the user.
Tracking code information.
Unique identifier for tracking code.
Name for tracking code.
Value for tracking code.
Response Codes
The list below describes the common success and error responses you should expect from the API.
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The 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. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The 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. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The 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. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too 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. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
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.
{
"personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xOGJiOWNjMC0zMWM2LTQ3MzYtYmE4OC0wMDk5ZmQzNDNmODE",
"email": "john.andersen@example.com",
"siteUrl": "example.webex.com",
"trackingCodes": [
{
"name": "Department",
"value": "Sales"
},
{
"name": "Division",
"value": "Part-time"
}
]
}
{
"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"
}
]
}