Update a licence tag

PATCH/licence_tags/{name}

Costs 2 rate-limit points · Rate limits

Rename a licence tag (new_name), as the Licence keys page's Rename tag does: every key and licence-key file of this shop moves to the new name.

No Tag and Autogenerated cannot be renamed. 422 when a tag with the new name exists; use POST /licences/move to merge.

Also searched asrename tagrename licence tagchange tag name

Path parameters

namestringRequired

Request body

new_namestringRequired
Example: ebook-2027

Returns

The licence tag 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/licence_tags/{name}

curl -X PATCH "https://app.filemonk.io/api/v2/external/licence_tags/{name}" \
  -H "X-Auth-Token: $FILEMONK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "new_name": "ebook-2027"
  }'

const res = await fetch("https://app.filemonk.io/api/v2/external/licence_tags/{name}", {
  method: "PATCH",
  headers: {
    "X-Auth-Token": process.env.FILEMONK_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "new_name": "ebook-2027"
  }),
});
const data = await res.json();

import os
import requests

res = requests.patch(
    "https://app.filemonk.io/api/v2/external/licence_tags/{name}",
    headers={"X-Auth-Token": os.environ["FILEMONK_API_KEY"]},
    json={
        "new_name": "ebook-2027"
    },
)
data = res.json()

require "net/http"
require "json"

uri = URI("https://app.filemonk.io/api/v2/external/licence_tags/{name}")
req = Net::HTTP::Patch.new(uri, "X-Auth-Token" => ENV["FILEMONK_API_KEY"], "Content-Type" => "application/json")
req.body = {
  new_name: "ebook-2027"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)

Response

{
  "name": "ebook-2027",
  "virtual": false,
  "licences": {
    "total": 2,
    "pending": 2,
    "assigned": 0,
    "used": 0
  },
  "digital_products": []
}

{
  "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)."
}