Set the license - Cognigy Documentation

POST

v2.0

system

license

Set the license

curl --request POST \
  --url https://api-trial.cognigy.ai/new/v2.0/system/license \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "email": "jsmith@example.com",
  "password": "<string>",
  "licensekey": "<string>"
}'

{
  "message": "The new license was installed within the system."
}

Authorizations

X-API-Key

string

header

required

Supply the API Key in the HTTP-Header

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

api_key

string

query

required

Supply the API Key in the Url-Query

Headers

enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:

application/json,

application/hal+json,

application/xml,

text/xml,

text/csv

Query Parameters

organisationId

string

Body

application/json

string<email>

password

string

licensekey

string

Response

Successfully updated the System License

message

string

The success message.

Example:

"The new license was installed within the system."

Get potential system wide maintenance messages

⌘I

Set the license

curl --request POST \
  --url https://api-trial.cognigy.ai/new/v2.0/system/license \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "email": "jsmith@example.com",
  "password": "<string>",
  "licensekey": "<string>"
}'

{
  "message": "The new license was installed within the system."
}