{
  "opencollection": "1.0.0",
  "info": {
    "name": "Webex Admin Address Book Wholesale Provisioning API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Wholesale Provisioning",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Wholesale Customers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/wholesale/customers",
            "params": [
              {
                "name": "externalId",
                "value": "c1677a16-557a-4fb4-b48f-24adde57ec99",
                "type": "query",
                "description": "Customer external ID."
              },
              {
                "name": "orgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi81MmNmNTc2ZC02MGE4LTQwN2EtYjIyYy00NjdjNTE1OTE5MDg",
                "type": "query",
                "description": "The encoded Organization ID for the customer."
              },
              {
                "name": "status",
                "value": "provisioned_with_errors",
                "type": "query",
                "description": "Customer API status."
              },
              {
                "name": "offset",
                "value": "10",
                "type": "query",
                "description": "Offset value for implementing pagination."
              },
              {
                "name": "max",
                "value": "10",
                "type": "query",
                "description": "The maximum number of customers returned in the response."
              },
              {
                "name": "onBehalfOfSubPartnerOrgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
                "type": "query",
                "description": "The encoded organization ID for the sub partner."
              }
            ]
          },
          "docs": "Return a list of wholesale customers. There are a number of filter options, which can be combined in a single request."
        },
        {
          "info": {
            "name": "Provision a Wholesale Customer",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/wholesale/customers",
            "params": [
              {
                "name": "onBehalfOfSubPartnerOrgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
                "type": "query",
                "description": "The encoded organization ID for the sub partner."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Provision a Wholesale customer for Cisco Webex services.\n\nThis API will allow a Service Provider to map the Wholesale customer and assign the required licenses and entitlements for Webex, Calling and Meetings.\n\nThe Wholesale customer provisioning is asynchronous and thus a background task is created when this endpoint is invoked.\n\n**packages Note:**\n\n* `cisco_calling_plan` is dependent on: `common_area_calling`, `webex_calling`, `webex_suite`, `webex_voice`, `cx_essentials`, `webex_calling_stand"
        },
        {
          "info": {
            "name": "Get a Wholesale Customer",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/wholesale/customers/:customerId",
            "params": [
              {
                "name": "customerId",
                "value": "Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtNjBhOC00MDdhLWIyMmMtNDY3YzUxNTkxOTA4",
                "type": "path",
                "description": "A unique identifier for the customer in question."
              },
              {
                "name": "onBehalfOfSubPartnerOrgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
                "type": "query",
                "description": "The encoded organization ID for the sub partner."
              },
              {
                "name": "includePackageLicenseInfo",
                "value": "true",
                "type": "query",
                "description": "If specified as true, a list of licenseIds will be returned for all provisioned packages"
              }
            ]
          },
          "docs": "Retrieves details of a provisioned Wholesale customer on Cisco Webex."
        },
        {
          "info": {
            "name": "Update a Wholesale Customer",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/wholesale/customers/:customerId",
            "params": [
              {
                "name": "customerId",
                "value": "Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtNjBhOC00MDdhLWIyMmMtNDY3YzUxNTkxOTA4",
                "type": "path",
                "description": "A unique identifier for the customer to be updated."
              },
              {
                "name": "onBehalfOfSubPartnerOrgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
                "type": "query",
                "description": "The encoded organization ID for the sub partner."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates certain details of a provisioned Wholesale customer for Cisco Webex services.\n\nThe Wholesale customer provisioning is asynchronous and thus a background task is created when this endpoint is invoked.\n\n**packages Note:**\n\n* `cisco_calling_plan` is dependent on: `common_area_calling`, `webex_calling`, `webex_suite`, `webex_voice`, `cx_essentials`, `webex_calling_standard`\n\n* `attendant_console` is dependent on: `webex_calling`, `webex_suite`, `cx_essentials`\n\n<div>\n        <Callout type='i"
        },
        {
          "info": {
            "name": "Remove a Wholesale Customer",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/wholesale/customers/:customerId",
            "params": [
              {
                "name": "customerId",
                "value": "Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtNjBhOC00MDdhLWIyMmMtNDY3YzUxNTkxOTA4",
                "type": "path",
                "description": "A unique identifier for the customer in question."
              },
              {
                "name": "onBehalfOfSubPartnerOrgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
                "type": "query",
                "description": "The encoded organization ID for the sub partner."
              }
            ]
          },
          "docs": "Removes the mapping between a Wholesale Customer and a Cisco Webex organization.."
        },
        {
          "info": {
            "name": "Precheck a Wholesale Customer Provisioning",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/wholesale/customers/validate",
            "params": [
              {
                "name": "onBehalfOfSubPartnerOrgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
                "type": "query",
                "description": "The encoded organization ID for the sub partner."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Allows the Partner sales team to verify likely success of provisioning a Wholesale customer.\n\n**packages Note:**\n\n* `cisco_calling_plan` is dependent on: `common_area_calling`, `webex_calling`, `webex_suite`, `webex_voice`, `cx_essentials`, `webex_calling_standard`\n\n* `attendant_console` is dependent on: `webex_calling`, `webex_suite`, `cx_essentials`\n\n<div>\n<Callout type='info'>\nThe Prerequisite for using this API is to have `wxc-wholesale` entitlement or `webex-wholesale-partner-testing` setti"
        },
        {
          "info": {
            "name": "List Wholesale Sub-partners",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/wholesale/subPartners",
            "params": [
              {
                "name": "provisioningState",
                "value": "active",
                "type": "query",
                "description": "Status to filter sub-partners based on provisioning state."
              },
              {
                "name": "offset",
                "value": "10",
                "type": "query",
                "description": "Offset value for implementing pagination."
              },
              {
                "name": "max",
                "value": "10",
                "type": "query",
                "description": "The maximum number of sub-partners returned in the response."
              }
            ]
          },
          "docs": "Lists all of the associated sub-partners. There are a number of filter and pagination options that can be combined in a single request."
        },
        {
          "info": {
            "name": "List Wholesale Subscribers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/wholesale/subscribers",
            "params": [
              {
                "name": "max",
                "value": "10",
                "type": "query",
                "description": "Limit the maximum number of subscribers returned in the search response, up to 100 per page. Refer to the [Pagination](/docs/basics#pagination) section of [Webex REST API Basics](/docs/api/basics)."
              },
              {
                "name": "offset",
                "value": "4",
                "type": "query",
                "description": "Offset value to implement [pagination](/docs/basics#pagination)."
              },
              {
                "name": "customerId",
                "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
                "type": "query",
                "description": "Wholesale customer ID."
              },
              {
                "name": "personId",
                "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
                "type": "query",
                "description": "The person ID of the subscriber used in the [/v1/people API](/docs/api/v1/people)."
              },
              {
                "name": "externalCustomerId",
                "value": "c1677a16-557a-4fb4-b48f-24adde57ec99",
                "type": "query",
                "description": "Customer external ID."
              },
              {
                "name": "email",
                "value": "john.anderson@acme.com",
                "type": "query",
                "description": "The email address of the subscriber."
              },
              {
                "name": "status",
                "value": "provisioned",
                "type": "query",
                "description": "The provisioning status of the subscriber."
              },
              {
                "name": "after",
                "value": "1579046400245",
                "type": "query",
                "description": "Only include subscribers created after this date and time. Epoch time (in milliseconds) preferred, but ISO 8601 date format also accepted."
              },
              {
                "name": "lastStatusChange",
                "value": "1579046400245",
                "type": "query",
                "description": "Only include subscribers with a provisioning status change after this date and time. Epoch time (in milliseconds) preferred, but ISO 8601 date format also accepted."
              },
              {
                "name": "sortBy",
                "value": "userCreationTimestamp",
                "type": "query",
                "description": "Supported `sortBy` attributes are `created` and `lastStatusChange`. Default is `created`."
              },
              {
                "name": "sortOrder",
                "value": "ASC",
                "type": "query",
                "description": "Sort by `ASC` (ascending) or `DESC` (descending)."
              },
              {
                "name": "onBehalfOfSubPartnerOrgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
                "type": "query",
                "description": "The encoded organization ID for the sub partner."
              }
            ]
          },
          "docs": "Allows a Service Provider to search for their associated subscribers. There are a number of filter options, which can be combined in a single request."
        },
        {
          "info": {
            "name": "Provision a Wholesale Subscriber",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/wholesale/subscribers",
            "params": [
              {
                "name": "onBehalfOfSubPartnerOrgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
                "type": "query",
                "description": "The encoded organization ID for the sub partner."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Provision a new Wholesale subscriber for Cisco Webex services.\n\nThis API allows a Service Provider to map the Wholesale subscriber to a Cisco Webex Wholesale customer and assign the required licenses and entitlements for Webex, Calling and Meetings.\n\n**Note:**\n\n* If this subscriber is an existing Webex Calling entitled user, the `locationId`, `primaryPhoneNumber` and `extension` are optional and if provided are ignored.\n\n**packages Note:**\n\n* `attendant_console` is dependent on: `webex_calling`,"
        },
        {
          "info": {
            "name": "Get a Wholesale Subscriber",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/wholesale/subscribers/:subscriberId",
            "params": [
              {
                "name": "subscriberId",
                "value": "Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk",
                "type": "path",
                "description": "A unique identifier for the subscriber in question."
              },
              {
                "name": "onBehalfOfSubPartnerOrgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
                "type": "query",
                "description": "The encoded organization ID for the sub partner."
              }
            ]
          },
          "docs": "Retrieves details of a provisioned Wholesale subscriber on Cisco Webex."
        },
        {
          "info": {
            "name": "Update a Wholesale Subscriber",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/wholesale/subscribers/:subscriberId",
            "params": [
              {
                "name": "subscriberId",
                "value": "Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk",
                "type": "path",
                "description": "A unique identifier for the subscriber in question."
              },
              {
                "name": "onBehalfOfSubPartnerOrgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
                "type": "query",
                "description": "The encoded organization ID for the sub partner."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates certain details of a provisioned Wholesale subscriber.\n\n**Note:**\n\n* The `provisioningParameters` attributes should only be supplied when changing from the webex_meetings package to any calling-enabled package.\n\n* Even in that scenario, if this subscriber is an existing Webex Calling entitled user, these attributes are optional and if provided are ignored.\n\n**packages Note:**\n\n* `attendant_console` is dependent on: `webex_calling`, `webex_suite`, `cx_essentials`\n\n<div>\n<Callout type='inf"
        },
        {
          "info": {
            "name": "Remove a Wholesale Subscriber",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/wholesale/subscribers/:subscriberId",
            "params": [
              {
                "name": "subscriberId",
                "value": "Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk",
                "type": "path",
                "description": "A unique identifier for the subscriber in question."
              },
              {
                "name": "onBehalfOfSubPartnerOrgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
                "type": "query",
                "description": "The encoded organization ID for the sub partner."
              }
            ]
          },
          "docs": "Removes the mapping between Wholesale Subscriber and a Webex user."
        },
        {
          "info": {
            "name": "Precheck a Wholesale Subscriber Provisioning",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/wholesale/subscribers/validate",
            "params": [
              {
                "name": "onBehalfOfSubPartnerOrgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
                "type": "query",
                "description": "The encoded organization ID for the sub partner."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Allows the Partner sales team to verify likely success of provisioning a wholesale subscriber.\n**packages Note:**\n\n* `attendant_console` is dependent on: `webex_calling`, `webex_suite`, `cx_essentials`\n\n<div>\n<Callout type='info'>\nThe Prerequisite for using this API is to have `wxc-wholesale` entitlement or `webex-wholesale-partner-testing` setting enabled for the Partner Organization. The Provisioning Precheck APIs supports three variants of Wholesale Subscriber Provisioning Precheck Requests. "
        },
        {
          "info": {
            "name": "Send Consent User Move Email to Pending Wholesale Subscribers",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/subscribers/:subscriberId/emails/consentMove",
            "params": [
              {
                "name": "subscriberId",
                "value": "Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk",
                "type": "path",
                "description": "A unique identifier for the subscriber in question."
              },
              {
                "name": "onBehalfOfSubPartnerOrgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
                "type": "query",
                "description": "The encoded organization ID for the sub partner."
              }
            ]
          },
          "docs": "Allows a Service Provider to send the user consent move email to a subscriber who is currently in `pending_user_migration` state."
        }
      ]
    }
  ],
  "bundled": true
}