PATCH /service/api/securecloud/customers/{customerId}/subscriptions/{subscriptionKey}

Updates subscription details.

Note: This method updates O365 license quantities through regular JSON patches for partial object updates. Note that it does not support JSON Patch operations as defined in RFC 6902.

Requirements:

The subscription key can be provided either in Base64-encoded form or as an unencoded string, and should be passed as the subscriptionKey parameter in the URL path.
Currently limited to O365 license quantity updates only.

Request Information

URI Parameters

Name	Description	Type	Additional Information
customerId	A unique id by which an end customer is identified.	string	Required
subscriptionKey	A unique identifier, either encoded or non-encoded, used to identify a subscription.	string	Required

URI Sample(s)


PATCH	https://unityapi.webrootcloudav.com/service/api/securecloud/customers/1e0a7a3c-92b7-480d-a48f-a38600f660bf/subscriptions/MTI1OTQ3LUJBQ0tVUC0zMS10bGguZG9tYWluc3dhcC56aXh0ZXN0LnRlc3Q=
PATCH	https://unityapi.webrootcloudav.com/service/api/securecloud/customers/1e0a7a3c-92b7-480d-a48f-a38600f660bf/subscriptions/125947-BACKUP-31-tlh.domainswap.zixtest.test

Body Parameters

Information about the subscription to be updated.

UpdateSubscriptionRequestModel

Name	Description	Type	Additional Information
ConfigurableSubscriptionDetails	Set of subscription properties that can be updated. Each subscription property consists of a name/value pair.	Collection of UpdateConfigurableSubscriptionDetail	None.

Sample Request

{
  "ConfigurableSubscriptionDetails": [
    {
      "Name": "SubscriptionQuantity",
      "Value": "5"
    }
  ]
}

<UpdateSubscriptionRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.SecureCloud.Models">
  <ConfigurableSubscriptionDetails>
    <UpdateSubscriptionRequestModel.UpdateConfigurableSubscriptionDetail>
      <Name>SubscriptionQuantity</Name>
      <Value>5</Value>
    </UpdateSubscriptionRequestModel.UpdateConfigurableSubscriptionDetail>
  </ConfigurableSubscriptionDetails>
</UpdateSubscriptionRequestModel>

Response Information

Resource Description

Information received after updating the license quantity.

UpdateSubscriptionResponseModel

Name	Description	Type	Additional Information
Message	Information received after updating the subscription.	string	None.

Sample Response

{
  "Message": "The request has been accepted for processing."
}

<UpdateSubscriptionResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.SecureCloud.Models">
  <Message>The request has been accepted for processing.</Message>
</UpdateSubscriptionResponseModel>