Update a licence

PATCH/licences/{id}

Costs 2 rate-limit points · Rate limits

Edit one licence key, as the Licence keys page's edit does: key (the text), key_status (pending, assigned, used) or tags (the whole list). Deep partial.

Changing key_status does not touch the order the key is on; use the order's licence endpoints for that.

Also searched asedit licence keyfix a typo in a keymark key as usedretag one keychange key status

Path parameters

idstringRequired

Request body

keyany
key_statusstring
Example: used
tagsany

Returns

The licence object.

Errors

401

Missing or invalid API key.

404

The resource does not exist for this shop, or the action path is not registered.

422

The request failed validation, or sent a key the action does not take (code: "unknown_parameters" with unknown and accepted). Nothing was saved.

429

Rate limited. Cost-weighted per API key, shared with API v1: a read costs 1 point, a write 2, 40 points per fixed 60-second window. Every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix time the window ends); a 429 adds Retry-After (seconds), retry_after, retryable: true and a next_step in the body. A 429 did nothing: wait retry_after seconds, then send the same request again. The budget is per key, so every tool or script using the key shares it; prefer one list call with per_page over many single reads.

Every error has the same shape: see Errors.

PATCH/licences/{id}

curl -X PATCH "https://app.filemonk.io/api/v2/external/licences/bcc87d33-c87e-4f39-9cd2-e43250ebc1ed" \
  -H "X-Auth-Token: $FILEMONK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "key_status": "used"
  }'

const res = await fetch("https://app.filemonk.io/api/v2/external/licences/bcc87d33-c87e-4f39-9cd2-e43250ebc1ed", {
  method: "PATCH",
  headers: {
    "X-Auth-Token": process.env.FILEMONK_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "key_status": "used"
  }),
});
const data = await res.json();

import os
import requests

res = requests.patch(
    "https://app.filemonk.io/api/v2/external/licences/bcc87d33-c87e-4f39-9cd2-e43250ebc1ed",
    headers={"X-Auth-Token": os.environ["FILEMONK_API_KEY"]},
    json={
        "key_status": "used"
    },
)
data = res.json()

require "net/http"
require "json"

uri = URI("https://app.filemonk.io/api/v2/external/licences/bcc87d33-c87e-4f39-9cd2-e43250ebc1ed")
req = Net::HTTP::Patch.new(uri, "X-Auth-Token" => ENV["FILEMONK_API_KEY"], "Content-Type" => "application/json")
req.body = {
  key_status: "used"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)

Response

{
  "id": "bcc87d33-c87e-4f39-9cd2-e43250ebc1ed",
  "key": "ABCD-EFGH-0005",
  "source": "uploaded",
  "status": "used",
  "tags": [
    "ebook-2026"
  ],
  "assigned_at": null,
  "order": null,
  "file": null,
  "created_at": "2026-10-30T16:48:56Z"
}

{
  "errors": [
    "Invalid API key"
  ]
}

{
  "errors": [
    "Order not found: c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f"
  ]
}

{
  "errors": [
    "access.download_limit_count must be an integer of at least 0"
  ],
  "field_errors": {
    "access.download_limit_count": [
      "must be an integer of at least 0"
    ]
  }
}

{
  "errors": [
    "You have exceeded the rate limit of 40 points per 60 seconds. Read requests cost 1 point(s) and write requests cost 2 point(s). Please retry after 12 second(s)."
  ],
  "code": "rate_limited",
  "retry_after": 12,
  "error": "Rate limit exceeded",
  "message": "You have exceeded the rate limit of 40 points per 60 seconds. Read requests cost 1 point(s) and write requests cost 2 point(s). Please retry after 12 second(s)."
}