Move licence keys to another tag

POST/licences/move

Costs 2 rate-limit points · Rate limits

Move licence keys into a tag (to_tag), replacing the tags they had, as the Licence keys page's Move does: either ids (a list) or tag (every key of that tag, No Tag included). to_tag must exist already, or be No Tag to clear tags.

Also searched asmove keys to tagretag licence keysmerge tagsuntag keys

Request body

to_tagstringRequired
Example: ebook-2027
idsarray of strings
tagany

Returns

movedinteger, nullable
Example: 1
to_tagobject
Show 4 child attributesHide child attributes
- namestring, nullable
  Example: ebook-2027
- virtualboolean, nullable
  Example: false
- licencesobject
  Show 4 child attributesHide child attributes
  - totalinteger, nullable
    Example: 2
  - pendinginteger, nullable
    Example: 2
  - assignedinteger, nullable
    Example: 0
  - usedinteger, nullable
    Example: 0
- digital_productsarray of anys

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.

POST/licences/move

curl -X POST "https://app.filemonk.io/api/v2/external/licences/move" \
  -H "X-Auth-Token: $FILEMONK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "ids": [
      "bcc87d33-c87e-4f39-9cd2-e43250ebc1ed"
    ],
    "to_tag": "ebook-2027"
  }'

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

import os
import requests

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

require "net/http"
require "json"

uri = URI("https://app.filemonk.io/api/v2/external/licences/move")
req = Net::HTTP::Post.new(uri, "X-Auth-Token" => ENV["FILEMONK_API_KEY"], "Content-Type" => "application/json")
req.body = {
  ids: [
    "bcc87d33-c87e-4f39-9cd2-e43250ebc1ed"
  ],
  to_tag: "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

{
  "moved": 1,
  "to_tag": {
    "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)."
}