POST /service/api/ecom/shop/trials

Creates a trial license for a given product.

Request Information

URI Parameters

None.

URI Sample(s)

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

Body Parameters

Information about the product trial to process.

NOTE: Each partner account configuration can have different products set up, which restrict the values that can be specified for the LicenseCategoryName and LicenseSeats fields. Please work with your Webroot e-commerce business partner to identify valid order combinations.

CreateTrialProductRequestServiceModel
NameDescriptionTypeAdditional Information
LicenseSeats

The number of seats the trial license should have.

 integer

Required
LicenseCategoryName

License category associated to this item.

Possible values are for example: OTSF, CBEP, WSAV, WSAI, WSAC, SAEP, SDNS, SECA.

 string

Required
LicenseKeycodeTypeId

The identifier of a license's keycode type.

Possible values are: 1 = standard license, 3 = parent license. If not specified, a default of 1 is assumed.

 integer

None.
FirstName

The first name of the customer.

 string

Required (for business products)
LastName

The last name of the customer.

 string

Required (for business products)
Address1

Address line.

 string

Required (for business products)
City

The city of the customer.

 string

Required (for business products)
PostalCode

The postal code of the customer.

 string

Required (for business products)
State

The ISO two-letter or three-letter code for the state.

 string

Required (for business products and certain countries like US, CA, AU, NZ, ZA)
Country

The ISO two-letter code for the country.

 string

Required (for business products)
CustomerEmail

The email address of the customer.

 string

Required
CompanyName

The name of the customer's company.

 string

Required (for business products)
VendorCustomerCode

An arbitrary value that can be assigned to identify the recipient of the license.

 string

None.
VaultId

Defines which data center vault to use (applicable to OTSF and CBEP). Note that ids are associated to license categories. As an example, a value of '1' defines a data center in the US for CBEP. Supported values are:

  • CBEP:
    • 1 = US
    • 2 = EMEA
    • 3 = CA
    • 4 = FR
    • 5 = APAC
    • 15 = AU
    • 16 = UK
  • OTSF
    • 8 = East US 2 (Virginia)
    • 9 = Australia East (New South Wales)
    • 10 = Canada Central (Toronto)
    • 11 = France Central (Paris)
    • 12 = UK South (London)
    • 13 = Germany

integer

None.
ProductPlatformId

Platform to use for this item (applicable to CBEP only). If nothing is provided, a default value of 1 is assumed. Currently supported values are:

  • 1 = Carbonite. Valid for LicenseKeycodeTypeId 3 and 1.
  • 2 = Azure EA. Valid for Business Single Site in Reseller Cart (LicenseKeycodeTypeId=1).
  • 3 = OnPrem. Valid for Business Single Site in Reseller Cart (LicenseKeycodeTypeId=1).

integer

None.
Modules

The modules to be added to this trial product.

 Collection of CreateTrialProductRequestServiceModel_Module

None.

Sample Request

{
  "LicenseSeats": 845,
  "LicenseCategoryName": "SAEP",
  "LicenseKeycodeTypeId": 3,
  "FirstName": "John",
  "LastName": "Doe",
  "Address1": "Webroot Way 21",
  "City": "Broomfield",
  "PostalCode": "80021",
  "State": "CO",
  "Country": "US",
  "CustomerEmail": "jdoe@webroot.com",
  "CompanyName": "ACME, Inc.",
  "VendorCustomerCode": "E000258048",
  "VaultId": null,
  "ProductPlatformId": null,
  "Modules": [
    {
      "LicenseSeats": 265,
      "LicenseCategoryName": "SDNS",
      "VaultId": null,
      "ProductPlatformId": null
    },
    {
      "LicenseSeats": 600,
      "LicenseCategoryName": "SECA",
      "VaultId": null,
      "ProductPlatformId": null
    }
  ]
}                    
<CreateTrialProductRequestServiceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.ECom.Models">
  <Address1>Webroot Way 21</Address1>
  <City>Broomfield</City>
  <CompanyName>ACME, Inc.</CompanyName>
  <Country>US</Country>
  <CustomerEmail>jdoe@webroot.com</CustomerEmail>
  <FirstName>John</FirstName>
  <LastName>Doe</LastName>
  <LicenseCategoryName>SAEP</LicenseCategoryName>
  <LicenseKeycodeTypeId>3</LicenseKeycodeTypeId>
  <LicenseSeats>845</LicenseSeats>
  <Modules>
    <CreateTrialProductRequestServiceModel_Module>
      <LicenseCategoryName>SDNS</LicenseCategoryName>
      <LicenseSeats>265</LicenseSeats>
      <ProductPlatformId i:nil="true" />
      <VaultId i:nil="true" />
    </CreateTrialProductRequestServiceModel_Module>
    <CreateTrialProductRequestServiceModel_Module>
      <LicenseCategoryName>SECA</LicenseCategoryName>
      <LicenseSeats>600</LicenseSeats>
      <ProductPlatformId i:nil="true" />
      <VaultId i:nil="true" />
    </CreateTrialProductRequestServiceModel_Module>
  </Modules>
  <PostalCode>80021</PostalCode>
  <ProductPlatformId i:nil="true" />
  <State>CO</State>
  <VaultId i:nil="true" />
  <VendorCustomerCode>E000258048</VendorCustomerCode>
</CreateTrialProductRequestServiceModel>

Response Information

Resource Description

Details about the newly created product trial.

CreateTrialProductResponseServiceModel
NameDescriptionTypeAdditional Information
Message

Specifies if the user has duplicate registration.

 string

None.
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.
Profile

A dictionary of profiles.

 Dictionary of string [key] and CreateTrialProductResponseServiceModel_LicenseProfile [value]

None.
Customer

The customer associated to this license.

 CreateTrialProductResponseServiceModel_Customer

None.

Sample Response

{
  "Message": null,
  "LicenseId": 188487783,
  "Keycode": "F82A47842A7842BDBD09",
  "ProductLineDescription": "Webroot Business",
  "Profile": {
    "SAEP": {
      "LicenseCategoryName": "SAEP",
      "LicenseCategoryDescription": "Webroot Endpoint Protection",
      "LicenseSeats": 545,
      "LicenseKeycodeTypeId": 3,
      "StartDate": "2025-01-20T10:21:32",
      "ExpirationDate": "2026-10-31T07:51:27",
      "LicenseAttributeValue": 1,
      "LicenseAttributeValueDescription": "",
      "LicenseAttributeDescription": "",
      "CategoryTypeName": "full",
      "ItemHierarchyId": 1,
      "ItemHierarchyName": "primary",
      "LicenseStatusId": 0,
      "LicenseStatusDescription": "inactive",
      "UsagePricingModelId": null,
      "UsagePricingModelName": null,
      "UsageCheckDay": null,
      "VaultId": null,
      "VaultName": null,
      "Vaults": null,
      "ProductPlatformId": null,
      "ProductPlatformName": null,
      "RetentionModelId": null,
      "RetentionModelName": null
    },
    "SDNS": {
      "LicenseCategoryName": "SDNS",
      "LicenseCategoryDescription": "Webroot DNS Protection",
      "LicenseSeats": 963,
      "LicenseKeycodeTypeId": 3,
      "StartDate": "2025-01-20T00:05:09",
      "ExpirationDate": "2027-03-12T10:53:11",
      "LicenseAttributeValue": 1,
      "LicenseAttributeValueDescription": "",
      "LicenseAttributeDescription": "",
      "CategoryTypeName": "full",
      "ItemHierarchyId": 2,
      "ItemHierarchyName": "secondary",
      "LicenseStatusId": 3,
      "LicenseStatusDescription": "manually disabled",
      "UsagePricingModelId": null,
      "UsagePricingModelName": null,
      "UsageCheckDay": null,
      "VaultId": null,
      "VaultName": null,
      "Vaults": null,
      "ProductPlatformId": null,
      "ProductPlatformName": null,
      "RetentionModelId": null,
      "RetentionModelName": null
    }
  },
  "Customer": {
    "VendorCustomerCode": "38473",
    "FirstName": "John",
    "LastName": "Doe",
    "Address1": "Webroot Way 21",
    "City": "Broomfield",
    "PostalCode": "80021",
    "State": "CO",
    "Country": "US",
    "CustomerEmail": "jdoe@webroot.com",
    "CompanyName": "ACME, Inc."
  }
}                    
<CreateTrialProductResponseServiceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.ECom.Models">
  <Customer>
    <Address1>Webroot Way 21</Address1>
    <City>Broomfield</City>
    <CompanyName>ACME, Inc.</CompanyName>
    <Country>US</Country>
    <CustomerEmail>jdoe@webroot.com</CustomerEmail>
    <FirstName>John</FirstName>
    <LastName>Doe</LastName>
    <PostalCode>80021</PostalCode>
    <State>CO</State>
    <VendorCustomerCode>38473</VendorCustomerCode>
  </Customer>
  <Keycode>F82A47842A7842BDBD09</Keycode>
  <LicenseId>188487783</LicenseId>
  <Message i:nil="true" />
  <ProductLineDescription>Webroot Business</ProductLineDescription>
  <Profile xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringCreateTrialProductResponseServiceModel_LicenseProfilefLvholdK>
      <d2p1:Key>SAEP</d2p1:Key>
      <d2p1:Value>
        <CategoryTypeName>full</CategoryTypeName>
        <ExpirationDate>2026-10-31T07:51:27</ExpirationDate>
        <ItemHierarchyId>1</ItemHierarchyId>
        <ItemHierarchyName>primary</ItemHierarchyName>
        <LicenseAttributeDescription></LicenseAttributeDescription>
        <LicenseAttributeValue>1</LicenseAttributeValue>
        <LicenseAttributeValueDescription></LicenseAttributeValueDescription>
        <LicenseCategoryDescription>Webroot Endpoint Protection</LicenseCategoryDescription>
        <LicenseCategoryName>SAEP</LicenseCategoryName>
        <LicenseKeycodeTypeId>3</LicenseKeycodeTypeId>
        <LicenseSeats>545</LicenseSeats>
        <LicenseStatusDescription>inactive</LicenseStatusDescription>
        <LicenseStatusId>0</LicenseStatusId>
        <ProductPlatformId i:nil="true" />
        <ProductPlatformName i:nil="true" />
        <RetentionModelId i:nil="true" />
        <RetentionModelName i:nil="true" />
        <StartDate>2025-01-20T10:21:32</StartDate>
        <UsageCheckDay i:nil="true" />
        <UsagePricingModelId i:nil="true" />
        <UsagePricingModelName i:nil="true" />
        <VaultId i:nil="true" />
        <VaultName i:nil="true" />
        <Vaults i:nil="true" />
      </d2p1:Value>
    </d2p1:KeyValueOfstringCreateTrialProductResponseServiceModel_LicenseProfilefLvholdK>
    <d2p1:KeyValueOfstringCreateTrialProductResponseServiceModel_LicenseProfilefLvholdK>
      <d2p1:Key>SDNS</d2p1:Key>
      <d2p1:Value>
        <CategoryTypeName>full</CategoryTypeName>
        <ExpirationDate>2027-03-12T10:53:11</ExpirationDate>
        <ItemHierarchyId>2</ItemHierarchyId>
        <ItemHierarchyName>secondary</ItemHierarchyName>
        <LicenseAttributeDescription></LicenseAttributeDescription>
        <LicenseAttributeValue>1</LicenseAttributeValue>
        <LicenseAttributeValueDescription></LicenseAttributeValueDescription>
        <LicenseCategoryDescription>Webroot DNS Protection</LicenseCategoryDescription>
        <LicenseCategoryName>SDNS</LicenseCategoryName>
        <LicenseKeycodeTypeId>3</LicenseKeycodeTypeId>
        <LicenseSeats>963</LicenseSeats>
        <LicenseStatusDescription>manually disabled</LicenseStatusDescription>
        <LicenseStatusId>3</LicenseStatusId>
        <ProductPlatformId i:nil="true" />
        <ProductPlatformName i:nil="true" />
        <RetentionModelId i:nil="true" />
        <RetentionModelName i:nil="true" />
        <StartDate>2025-01-20T00:05:09</StartDate>
        <UsageCheckDay i:nil="true" />
        <UsagePricingModelId i:nil="true" />
        <UsagePricingModelName i:nil="true" />
        <VaultId i:nil="true" />
        <VaultName i:nil="true" />
        <Vaults i:nil="true" />
      </d2p1:Value>
    </d2p1:KeyValueOfstringCreateTrialProductResponseServiceModel_LicenseProfilefLvholdK>
  </Profile>
</CreateTrialProductResponseServiceModel>