POST /service/api/ecom/shop/trials/{keycode}/modules

Creates trial modules for a given parent keycode.

Request Information

URI Parameters

Name	Description	Type	Additional Information
keycode	The keycode of a parent console where trial module(s) should be created.	string	Required

URI Sample(s)


POST	https://unityapi.webrootcloudav.com/service/api/ecom/shop/trials/D3835D771C2B4F7B842F/modules

Body Parameters

Information about the trial(s) that should be created.

CreateModuleTrialRequestServiceModel

Name	Description	Type	Additional Information
Modules	Modules (e.g. DNS Protection or WSAT) for which trial licenses should be created.	Collection of CreateModuleTrialRequestServiceModel_Module	Required

Sample Request

{
  "Modules": [
    {
      "LicenseSeats": 450,
      "LicenseCategoryName": "SDNS",
      "VaultId": null,
      "ProductPlatformId": null
    },
    {
      "LicenseSeats": 844,
      "LicenseCategoryName": "SECA",
      "VaultId": null,
      "ProductPlatformId": null
    }
  ]
}

<CreateModuleTrialRequestServiceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.ECom.Models">
  <Modules>
    <CreateModuleTrialRequestServiceModel_Module>
      <LicenseCategoryName>SDNS</LicenseCategoryName>
      <LicenseSeats>450</LicenseSeats>
      <ProductPlatformId i:nil="true" />
      <VaultId i:nil="true" />
    </CreateModuleTrialRequestServiceModel_Module>
    <CreateModuleTrialRequestServiceModel_Module>
      <LicenseCategoryName>SECA</LicenseCategoryName>
      <LicenseSeats>844</LicenseSeats>
      <ProductPlatformId i:nil="true" />
      <VaultId i:nil="true" />
    </CreateModuleTrialRequestServiceModel_Module>
  </Modules>
</CreateModuleTrialRequestServiceModel>

Response Information

Resource Description

Details about the newly created trial(s).

CreateModuleTrialResponseServiceModel

Name	Description	Type	Additional Information
LicenseId	A unique identifier for the license that was queried.	integer	None.
Keycode	Keycode identifying the license.	string	None.
ProductLineDescription	Description of the associated product line.	string	None.
ParentLicenseId	Unique identifier for the parent license.	integer	None.
ParentKeycode	The keycode for the parent license.	string	None.
ChildLicenseActivations	Number of activations in child licenses.	integer	None.
PartnerStartDate	Start date of the partner.	date	None.
Profile	A dictionary of profiles.	Dictionary of string [key] and CreateModuleTrialResponseServiceModel_LicenseProfile [value]	None.
Customer	The customer associated to this license.	CreateModuleTrialResponseServiceModel_Customer	None.

Sample Response

{
  "LicenseId": 198668334,
  "Keycode": "9B9FF8C862E64A7F9F24",
  "ProductLineDescription": "Webroot Business",
  "ParentLicenseId": 102697144,
  "ParentKeycode": "93BD0D42014643959DE3",
  "ChildLicenseActivations": 8,
  "PartnerStartDate": "2024-03-14T22:13:48",
  "Profile": {
    "SAEP": {
      "LicenseCategoryName": "SAEP",
      "LicenseCategoryDescription": "Webroot Endpoint Protection",
      "LicenseSeats": 232,
      "LicenseKeycodeTypeId": 3,
      "StartDate": "2024-09-15T17:33:13",
      "ExpirationDate": "2027-11-13T13:20:43",
      "LicenseAttributeValue": null,
      "LicenseAttributeValueDescription": null,
      "LicenseAttributeDescription": null,
      "CategoryTypeName": "trial",
      "ItemHierarchyId": 1,
      "ItemHierarchyName": "primary",
      "LicenseStatusId": 1,
      "LicenseStatusDescription": "active",
      "UsagePricingModelId": null,
      "UsagePricingModelName": null,
      "UsageCheckDay": 15,
      "VaultId": null,
      "VaultName": null,
      "Vaults": null,
      "ProductPlatformId": null,
      "ProductPlatformName": null,
      "RetentionModelId": null,
      "RetentionModelName": null
    },
    "SDNS": {
      "LicenseCategoryName": "SDNS",
      "LicenseCategoryDescription": "Webroot DNS Protection",
      "LicenseSeats": 201,
      "LicenseKeycodeTypeId": 3,
      "StartDate": "2025-05-22T10:23:19",
      "ExpirationDate": "2028-03-21T17:30:40",
      "LicenseAttributeValue": null,
      "LicenseAttributeValueDescription": null,
      "LicenseAttributeDescription": null,
      "CategoryTypeName": "full",
      "ItemHierarchyId": 2,
      "ItemHierarchyName": "secondary",
      "LicenseStatusId": 2,
      "LicenseStatusDescription": "disabled",
      "UsagePricingModelId": null,
      "UsagePricingModelName": null,
      "UsageCheckDay": 15,
      "VaultId": null,
      "VaultName": null,
      "Vaults": null,
      "ProductPlatformId": null,
      "ProductPlatformName": null,
      "RetentionModelId": null,
      "RetentionModelName": null
    },
    "SECA": {
      "LicenseCategoryName": "SECA",
      "LicenseCategoryDescription": "Webroot Security Awareness",
      "LicenseSeats": 738,
      "LicenseKeycodeTypeId": 3,
      "StartDate": "2023-05-24T02:52:44",
      "ExpirationDate": "2027-11-10T15:01:28",
      "LicenseAttributeValue": null,
      "LicenseAttributeValueDescription": null,
      "LicenseAttributeDescription": null,
      "CategoryTypeName": "trial",
      "ItemHierarchyId": 2,
      "ItemHierarchyName": "secondary",
      "LicenseStatusId": 0,
      "LicenseStatusDescription": "inactive",
      "UsagePricingModelId": null,
      "UsagePricingModelName": null,
      "UsageCheckDay": 15,
      "VaultId": null,
      "VaultName": null,
      "Vaults": null,
      "ProductPlatformId": null,
      "ProductPlatformName": null,
      "RetentionModelId": null,
      "RetentionModelName": null
    }
  },
  "Customer": {
    "VendorCustomerCode": "18812"
  }
}

<CreateModuleTrialResponseServiceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.ECom.Models">
  <ChildLicenseActivations>8</ChildLicenseActivations>
  <Customer>
    <VendorCustomerCode>18812</VendorCustomerCode>
  </Customer>
  <Keycode>9B9FF8C862E64A7F9F24</Keycode>
  <LicenseId>198668334</LicenseId>
  <ParentKeycode>93BD0D42014643959DE3</ParentKeycode>
  <ParentLicenseId>102697144</ParentLicenseId>
  <PartnerStartDate>2024-03-14T22:13:48</PartnerStartDate>
  <ProductLineDescription>Webroot Business</ProductLineDescription>
  <Profile xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringCreateModuleTrialResponseServiceModel_LicenseProfilefLvholdK>
      <d2p1:Key>SAEP</d2p1:Key>
      <d2p1:Value>
        <CategoryTypeName>trial</CategoryTypeName>
        <ExpirationDate>2027-11-13T13:20:43</ExpirationDate>
        <ItemHierarchyId>1</ItemHierarchyId>
        <ItemHierarchyName>primary</ItemHierarchyName>
        <LicenseAttributeDescription i:nil="true" />
        <LicenseAttributeValue i:nil="true" />
        <LicenseAttributeValueDescription i:nil="true" />
        <LicenseCategoryDescription>Webroot Endpoint Protection</LicenseCategoryDescription>
        <LicenseCategoryName>SAEP</LicenseCategoryName>
        <LicenseKeycodeTypeId>3</LicenseKeycodeTypeId>
        <LicenseSeats>232</LicenseSeats>
        <LicenseStatusDescription>active</LicenseStatusDescription>
        <LicenseStatusId>1</LicenseStatusId>
        <ProductPlatformId i:nil="true" />
        <ProductPlatformName i:nil="true" />
        <RetentionModelId i:nil="true" />
        <RetentionModelName i:nil="true" />
        <StartDate>2024-09-15T17:33:13</StartDate>
        <UsageCheckDay>15</UsageCheckDay>
        <UsagePricingModelId i:nil="true" />
        <UsagePricingModelName i:nil="true" />
        <VaultId i:nil="true" />
        <VaultName i:nil="true" />
        <Vaults i:nil="true" />
      </d2p1:Value>
    </d2p1:KeyValueOfstringCreateModuleTrialResponseServiceModel_LicenseProfilefLvholdK>
    <d2p1:KeyValueOfstringCreateModuleTrialResponseServiceModel_LicenseProfilefLvholdK>
      <d2p1:Key>SDNS</d2p1:Key>
      <d2p1:Value>
        <CategoryTypeName>full</CategoryTypeName>
        <ExpirationDate>2028-03-21T17:30:40</ExpirationDate>
        <ItemHierarchyId>2</ItemHierarchyId>
        <ItemHierarchyName>secondary</ItemHierarchyName>
        <LicenseAttributeDescription i:nil="true" />
        <LicenseAttributeValue i:nil="true" />
        <LicenseAttributeValueDescription i:nil="true" />
        <LicenseCategoryDescription>Webroot DNS Protection</LicenseCategoryDescription>
        <LicenseCategoryName>SDNS</LicenseCategoryName>
        <LicenseKeycodeTypeId>3</LicenseKeycodeTypeId>
        <LicenseSeats>201</LicenseSeats>
        <LicenseStatusDescription>disabled</LicenseStatusDescription>
        <LicenseStatusId>2</LicenseStatusId>
        <ProductPlatformId i:nil="true" />
        <ProductPlatformName i:nil="true" />
        <RetentionModelId i:nil="true" />
        <RetentionModelName i:nil="true" />
        <StartDate>2025-05-22T10:23:19</StartDate>
        <UsageCheckDay>15</UsageCheckDay>
        <UsagePricingModelId i:nil="true" />
        <UsagePricingModelName i:nil="true" />
        <VaultId i:nil="true" />
        <VaultName i:nil="true" />
        <Vaults i:nil="true" />
      </d2p1:Value>
    </d2p1:KeyValueOfstringCreateModuleTrialResponseServiceModel_LicenseProfilefLvholdK>
    <d2p1:KeyValueOfstringCreateModuleTrialResponseServiceModel_LicenseProfilefLvholdK>
      <d2p1:Key>SECA</d2p1:Key>
      <d2p1:Value>
        <CategoryTypeName>trial</CategoryTypeName>
        <ExpirationDate>2027-11-10T15:01:28</ExpirationDate>
        <ItemHierarchyId>2</ItemHierarchyId>
        <ItemHierarchyName>secondary</ItemHierarchyName>
        <LicenseAttributeDescription i:nil="true" />
        <LicenseAttributeValue i:nil="true" />
        <LicenseAttributeValueDescription i:nil="true" />
        <LicenseCategoryDescription>Webroot Security Awareness</LicenseCategoryDescription>
        <LicenseCategoryName>SECA</LicenseCategoryName>
        <LicenseKeycodeTypeId>3</LicenseKeycodeTypeId>
        <LicenseSeats>738</LicenseSeats>
        <LicenseStatusDescription>inactive</LicenseStatusDescription>
        <LicenseStatusId>0</LicenseStatusId>
        <ProductPlatformId i:nil="true" />
        <ProductPlatformName i:nil="true" />
        <RetentionModelId i:nil="true" />
        <RetentionModelName i:nil="true" />
        <StartDate>2023-05-24T02:52:44</StartDate>
        <UsageCheckDay>15</UsageCheckDay>
        <UsagePricingModelId i:nil="true" />
        <UsagePricingModelName i:nil="true" />
        <VaultId i:nil="true" />
        <VaultName i:nil="true" />
        <Vaults i:nil="true" />
      </d2p1:Value>
    </d2p1:KeyValueOfstringCreateModuleTrialResponseServiceModel_LicenseProfilefLvholdK>
  </Profile>
</CreateModuleTrialResponseServiceModel>