{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book Tracking Codes API", "version": "1.0.0" }, "items": [ { "info": { "name": "Tracking Codes", "type": "folder" }, "items": [ { "info": { "name": "List Tracking Codes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/meeting/config/trackingCodes", "params": [ { "name": "siteUrl", "value": "example.webex.com", "type": "query", "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API." } ] }, "docs": "Lists tracking codes on a site by an admin user.\n\n* If `siteUrl` is specified, tracking codes of the specified site will be listed; otherwise, tracking codes of the user's preferred site will be listed. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n* 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 " }, { "info": { "name": "Create a Tracking Code", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/meeting/config/trackingCodes", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new tracking code by an admin user.\n\n* 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](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n* 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 va" }, { "info": { "name": "Get a Tracking Code", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId", "params": [ { "name": "trackingCodeId", "value": "1", "type": "path", "description": "Unique identifier for the tracking code whose details are being requested." }, { "name": "siteUrl", "value": "example.webex.com", "type": "query", "description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API." } ] }, "docs": "Retrieves details for a tracking code by an admin user.\n\n* If `siteUrl` is specified, the tracking code is retrieved from the specified site; otherwise, the tracking code is retrieved from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n* Admins can switch any Control Hub managed site from using classic tracking codes to mapped tracking codes in Control Hub, this i" }, { "info": { "name": "Update a Tracking Code", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId", "body": { "type": "json", "data": "{}" } }, "docs": "Updates details for a tracking code by an admin user.\n\n* The `siteUrl` is required. The operation updates a tracking code for the specified site. All of a user's available Webex sites can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n* The `inputMode` of `hostProfileSelect` is only available for the host profile and sign-up pages and it doesn't apply to the meeting scheduler page or meeting start page. Therefore, `scheduleStartCodes` must be `null` or " }, { "info": { "name": "Delete a Tracking Code", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/meeting/config/trackingCodes/:trackingCodeId", "params": [ { "name": "trackingCodeId", "value": "1", "type": "path", "description": "Unique identifier for the tracking code to be deleted." }, { "name": "siteUrl", "value": "example.webex.com", "type": "query", "description": "URL of the Webex site from which the API deletes the tracking code. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API." } ] }, "docs": "Deletes a tracking code by an admin user.\n\n* The `siteUrl` is required. The operation deletes a tracking code for the specified site. All of a user's available Webex sites can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n* 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 attrib" }, { "info": { "name": "Get User Tracking Codes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes", "headers": [ { "name": "email", "value": "john.andersen@example.com" } ], "params": [ { "name": "siteUrl", "value": "example.webex.com", "type": "query", "description": "URL of the Webex site from which the API retrieves the tracking code. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API." }, { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xOGJiOWNjMC0zMWM2LTQ3MzYtYmE4OC0wMDk5ZmQzNDNmODE", "type": "query", "description": "Unique identifier for the user whose tracking codes are being retrieved. The admin user can specify the `personId` of a user on a site they manage and the API returns details for the user's tracking codes. At least one parameter of `personId` or `email` is required." } ] }, "docs": "Lists user's tracking codes by an admin user.\n\n* At least one parameter, either `personId`, or `email` is required. `personId` must come before `email` if both are specified. Please note that `email` is specified in the request header.\n\n* If `siteUrl` is specified, the tracking codes of the specified site will be listed; otherwise, the tracking codes of a user's preferred site are listed. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1" }, { "info": { "name": "Update User Tracking Codes", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/meeting/userconfig/trackingCodes", "body": { "type": "json", "data": "{}" } }, "docs": "Updates tracking codes for a specified user by an admin user.\n\n* 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](/docs/api/v1/meeting-preferences/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`.\n\n* A name that is not found in the site-level tracking codes cannot be set for a user's track" } ] } ], "bundled": true }