/license/activate

POST

/license/activate

curl --request POST \
  --url https://example.com/api/v1/license/activate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "key": "example" }'

Authorizations

• bearer

Request Body^required

Media typeapplication/json

object

key

required

string

>= 16 characters <= 8000 characters

Example^generated

{
  "key": "example"
}

Responses

200

Default Response

Media typeapplication/json

object

state

required

string

Allowed values: unlicensed evaluation active grace degraded restricted send_suspended

reason

required

Any of:

string

string

null

null

daysRemaining

required

Any of:

integer

integer

>= -9007199254740991 <= 9007199254740991

null

null

lapse

required

Any of:

string

string

Allowed values: billing technical

null

null

license

required

Any of:

object

object

licenseId

required

string

tier

required

string

maxMailboxes

required

integer

>= -9007199254740991 <= 9007199254740991

maxDomains

required

integer

>= -9007199254740991 <= 9007199254740991

issuedAt

required

string

expiresAt

required

string

features

required

Array<string>

issuedTo

required

Any of:

string

string

null

null

boundTo

required

Any of:

string

string

null

null

null

null

usage

required

object

mailboxes

required

integer

>= -9007199254740991 <= 9007199254740991

domains

required

integer

>= -9007199254740991 <= 9007199254740991

lastHeartbeatAt

required

Any of:

string

string

null

null

lastError

required

Any of:

string

string

null

null

claimedElsewhere

required

boolean

machine

required

string

Example

{
  "state": "unlicensed",
  "lapse": "billing"
}