Sign in

v50

latestOpenAPI 3.0.3AGPLv3raw.githubusercontent.com2026-04-1028178439.6 KB
Licensees

Update

Update Licensee

put/keys/{key}/licensees/{licensee}

Path parameters

keystring required

API Key

The API Key to retrieve. Begins ak_.

licenseestring required

Licensee Key

Uniquely identifies a licensee.

Query parameters

user_tokenstring

Private User Token

A secret key used for sensitive operations on your account and API Keys.

Your user token can be retrieved and managed from your accounts page.

Typically beings uk_...

Request body

namestring

Licensee individual or organisation name

addressstring

Licensee's first, second and third line address as well as post town concatenated by commas

postcodestring

Licensee's postcode

whiteliststring[]

A list of allowed URLs. An empty list means that whitelisting is disabled

Example request

{
  "name": "Qwerty Widgets Limited",
  "address": "12 High Street, Manchester",
  "postcode": "ID1 1QD",
  "whitelist": [
    "https://www.example.com"
  ],
  "daily": {
    "limit": 10000
  }
}

Response

Success

code2000 required
message'Success' required

Example response

{
  "result": {
    "name": "Qwerty Widgets Limited",
    "address": "12 High Street, Manchester",
    "postcode": "ID1 1QD",
    "whitelist": [
      "https://www.example.com"
    ],
    "daily": {
      "limit": 10000,
      "count": 232,
      "updatedAt": "2016-08-05T16:43:28.865Z"
    },
    "id": "56a11209ebe230380bf104c3",
    "key": "sl_ijoiqsxeQgXW2gkiE0X94",
    "createdAt": "2016-01-21T17:14:49.971Z"
  }
}