---
title: "Update a License Key"
method: PUT
path: "/ka/key/{keyId}"
tags: ["KA License Operations"]
---

# Update a License Key

`PUT /ka/key/{keyId}`

## Request

- Base URL: `https://api.socialbee.com`
- URL: `https://api.socialbee.com/ka/key/{keyId}`
- Auth: none declared

Updates an existing license key. Used to renew, reactivate, upgrade, and downgrade license keys.

## Path parameters

- `keyId` integer, required

## Query parameters

- `testMode` boolean, required
- `idempotencyKey` string, required

## Request body

- KALicenseDTO
  - `keyId` integer, required: KA license number (without prefix and version).
  - `productId` string: Product ID is an ID or SKU of the purchased product. The ISV endpoint should be aware of this ID/SKU. For SocialBee, this would be the code of the platform
  - `items` Item[]: A list of addons which will be added to the license (number of users in a workspace)
    - `item` string, required: The code of the addon
    - `value` string, required: The quantity of the addon
  - `status` string, required: The status of the license to be created. Fixed enum.
  - `body` string: Anything that we might want to store on the license (KA will keep pushing this back to us in the requests)
  - `storeURL` string: The partner store url
  - `creationDate` string, date-time, required: The date when the license was created
  - `operationDate` string, date-time, required: The date when the API request was made (think idempotency)
  - `expirationDate` string, date-time, required: The date when the license will expire
  - `owner` Owner, required: License owner in KA
    - `id` integer, required: The internal id of the owner.
  - `nfr` boolean, required: If nfr is true license key is not intended for production use and might be used for testing or development purposes. Also, such license key is not a subject for invoicing and billing, and, therefore, should not be counted in Plesk and ISV mutual settlements.
  - `activationData` string, required: Activation data is a packet of tech data required to obtain a valid application license.

## Response `200`

Successfully updated user

- KALicenseDTO
  - `keyId` integer, required: KA license number (without prefix and version).
  - `productId` string: Product ID is an ID or SKU of the purchased product. The ISV endpoint should be aware of this ID/SKU. For SocialBee, this would be the code of the platform
  - `items` Item[]: A list of addons which will be added to the license (number of users in a workspace)
    - `item` string, required: The code of the addon
    - `value` string, required: The quantity of the addon
  - `status` string, required: The status of the license to be created. Fixed enum.
  - `body` string: Anything that we might want to store on the license (KA will keep pushing this back to us in the requests)
  - `storeURL` string: The partner store url
  - `creationDate` string, date-time, required: The date when the license was created
  - `operationDate` string, date-time, required: The date when the API request was made (think idempotency)
  - `expirationDate` string, date-time, required: The date when the license will expire
  - `owner` Owner, required: License owner in KA
    - `id` integer, required: The internal id of the owner.
  - `nfr` boolean, required: If nfr is true license key is not intended for production use and might be used for testing or development purposes. Also, such license key is not a subject for invoicing and billing, and, therefore, should not be counted in Plesk and ISV mutual settlements.
  - `activationData` string, required: Activation data is a packet of tech data required to obtain a valid application license.

## Other responses

- `404`: The license key was not found

---

[API](https://skmtc.dev/socialbee/apis/socialbee-partner-api.md) - [All operations](https://skmtc.dev/socialbee/apis/socialbee-partner-api/llms.txt) - [OpenAPI document](https://skmtc.dev/socialbee/apis/socialbee-partner-api/revisions/6125f325ff0c?raw)