TOtogaihq
Licenses

Update a license entry

Changed on

This API let’s you to add a license entry

post/license_updates

Request

Request body

licenseIdstring required

The license id for which the update is requested

accountIdstring required

The account id for which the license is being updated

updateType'RELATIVE' | 'ABSOLUTE' required

The type of update to be performed

quantitynumber required

The quantity to be updated

effectiveFromstring date-time

The effective from date for the update

idempotencyKeystring

The idempotency key for uniqueness of the license update request

metadataobject

Example request

{
  "licenseId": "lic.fdjsl.313",
  "accountId": "acc.fdjsl.313",
  "effectiveFrom": "2021-03-04T14:25:10Z",
  "idempotencyKey": "idempotencyKey#1",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  }
}

Response

Success response

licenseIdstring required
accountIdstring required
quantitynumber required

Absolute quantity of the license

effectiveFromstring date-time required
metadataobject
createdAtstring date-time required

Example response

{
  "licenseId": "lic.fdjsl.313",
  "accountId": "acc.fdjsl.313",
  "quantity": 10,
  "effectiveFrom": "2021-03-04T14:25:10Z",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "createdAt": "2021-03-04T14:25:10Z"
}

Changes

  • 5abfbfe439beRevision changes
    • breaking

      the //// response's property type changed from integer to number for status

    • info

      the request property type was generalized from integer to number

  • ea9c4628bfdbRevision changes
    • info

      added the new optional request property

    • info

      added the optional property //// to the response with the status