ACaccessibe

Update an accessWidget license

Updates the details of the specified accessWidget license for the specified account. Any parameters not provided will be left unchanged. Use GET /accounts/{accountId}/access-widget-licenses and filter by domain to get the licenseId for a specific domain.

planSKU is the type of plan for the license where:

1 = Standard, 2 = Advanced Plus, 3 = Enterprise, 5 = Advanced, 21 = Micro, 22 = Growth, 23 = Scale

Note: If you pass null for a specific field in settings (for example leadColor: null), that field set to the default value.

patch/accounts/{accountId}/access-widget-licenses/{licenseId}

Request

Path parameters

accountIdstring required

The ID of the account. You can check your ID here

licenseIdstring required

The ID of the license.

Request body

domainstring required

domain of an exiting license

newDomainstring

New domain for the license, you can update only if you have the allowTransferByApi set to true

planSKU1 | 2 | 3 | 5 | 21 | 22 | 23

Plan SKU for the license.

contactNamestring

New full name of contact for the license

contactEmailstring

New contact email for the license

contactPhonestring

New contact phone for the license

contactCountryCodestring

New contact country code for the license

discountEnabledboolean

Set to true to enable discounts for the account. Set to false to get commissions instead of discounts. The parameter activate below must be set to true.

monthlyboolean

For monthly subscription can pass it as true, else it will be yearly

activateboolean

Activate the license, need to have in the account allowActivationByApi set to true

disableboolean

Disable the license, need to have in the account allowDisableByApi set to true

Example request

{
  "domain": "example.com",
  "newDomain": "test.com",
  "planSKU": 1,
  "contactName": "John Doe",
  "contactEmail": "johndoe@accessibe.com",
  "contactCountryCode": "US"
}

Response

License updated

successboolean
messagestring

Changes

No recorded changes to this operation across all 2 revisions of this API.