Skip to main content
POST
Reclaim pool licenses from a managed client

Authorizations

x-auth-apikey
string
header
required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme
enum<string>
default:partner-api-token
required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options:
api-token,
api,
partner-api-token,
partner-api

Body

application/json

Move pooled licenses held by a managed client back to the MSP.

clientOrgUuid
string<RUUID> | null
RUUID

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

forceUnassign
boolean | null

When true, device-assigned licenses are unassigned first (config downgrade included).

licenseUuids
(string<RUUID> | null)[] | null

Explicit licenses; or use productCode + quantity.

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

productCode
string | null
quantity
integer<int32> | null
int32
requestId
string | null

Idempotency key; retries with the same id are safe.

Response

200 - application/json

OK

Per-license outcome of a reclaim.

error
boolean | null
errorMsg
string | null
reclaimed
(string<RUUID> | null)[] | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

skipped
object[] | null
unassignedDevices
(string<RUUID> | null)[] | null

Devices whose license was force-unassigned by this call.

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

warningMsg
string | null
Last modified on September 22, 2026