Skip to main content
POST
Activate License Key
This endpoint is only relevant when device activations are turned on for the license key benefit. Call it to reserve an allocation for a particular device, then store the unique activation ID returned in the response on that device and reuse it as an extra check inside the /validate endpoint.Skipping activations? Head straight to the /validate endpoint instead.

Body

application/json
key
string
required
organization_id
string<uuid4>
required
label
string
required
conditions
Conditions · object

Key-value object allowing you to set conditions that must match when validating the license key.

The key must be a string with a maximum length of 40 characters. The value must be either:

  • A string with a maximum length of 500 characters
  • An integer
  • A floating-point number
  • A boolean

You can store up to 50 key-value pairs.

meta
Meta · object

Metadata map for information your integration needs to retain about the activation

The key must be a string with a maximum length of 40 characters. The value must be either:

  • A string with a maximum length of 500 characters
  • An integer
  • A floating-point number
  • A boolean

You can store up to 50 key-value pairs.

Response

Request completed successfully

id
string<uuid4>
required
license_key_id
string<uuid4>
required
label
string
required
meta
Meta · object
required
created_at
string<date-time>
required
modified_at
string<date-time> | null
required
license_key
LicenseKeyRead · object
required