Skip to main content
POST
/
license_updates
curl --request POST \
  --url https://api.togai.com/license_updates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "licenseId": "addon.21LdC76myzw.uiSWm",
  "accountId": "account#1",
  "updateType": "ABSOLUTE",
  "quantity": 10
}
'
{
  "licenseId": "lic.fdjsl.313",
  "accountId": "acc.fdjsl.313",
  "quantity": 10,
  "effectiveFrom": "2020-01-01T00:00:00Z",
  "createdAt": "2021-03-04T14:25:10Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

License update request

​
licenseId
string
required

The license id for which the update is requested

Maximum string length: 50
Example:

"lic.fdjsl.313"

​
accountId
string
required

The account id for which the license is being updated

Maximum string length: 50
Example:

"acc.fdjsl.313"

​
updateType
enum<string>
required

The type of update to be performed

Available options:
RELATIVE,
ABSOLUTE
​
quantity
number
required

The quantity to be updated

​
effectiveFrom
string<date-time>

The effective from date for the update

Example:

"2021-03-04T14:25:10Z"

​
idempotencyKey
string

The idempotency key for uniqueness of the license update request

Example:

"idempotencyKey#1"

​
metadata
object
Example:
{ "key1": "value1", "key2": "value2" }

Response

Success response

License update

​
licenseId
string
required
Maximum string length: 50
Example:

"lic.fdjsl.313"

​
accountId
string
required
Maximum string length: 50
Example:

"acc.fdjsl.313"

​
quantity
number
required

Absolute quantity of the license

Example:

10

​
effectiveFrom
string<date-time>
required
Example:

"2021-03-04T14:25:10Z"

​
createdAt
string<date-time>
required
Example:

"2021-03-04T14:25:10Z"

​
metadata
object
Example:
{ "key1": "value1", "key2": "value2" }