Skip to main content

addProductKey

This method adds a license or addon-key to the existing list of licenses and addon-keys.

Parameters

Parameter

Type

Optional

Description

licenseKey

String

No

The license key to be set. It can be an add-on or a base license.

companyId

String

Yes

The ID of the company whose license will be set. If no value is passed, the user's company will be selected.

replaceIncompatibleKeys

Boolean

Yes

If true, all existing base licenses or add-ons that are not compatible with the current license key will be removed and the new license will be added to the existing base licenses or add-on keys. The default value is true.

Return value

This method does not return any value.

Example

Request:

  {        
       "params": {
           "licenseKey" : "TNB3AAA",
           "companyId" : "5493dcd2b1a43df00b7b23c6",
           "replaceIncompatibleKeys" : true
        },
        "jsonrpc": "2.0",
        "method": "addProductKey",
        "id": "48daf1bc-4078-411c-bf44-4f293e68f501"
  }

Response:

  {
        "id":"48daf1bc-4078-411c-bf44-4f293e68f501",
        "jsonrpc":"2.0",
        "result": null
}
In this section: