Skip to content

Deactivate License ​

Remove an activation and free its slot.

Request ​

POST /api/index.php/v1/licensedock/licenses/deactivate

Parameters ​

ParameterTypeRequiredNotes
license_keystringYesThe license key. dlid is accepted as an alias
identifierstringYesThe activation to remove. Normalised the same way as on activate
product_idintegerRecommendedA key for another product is refused with PRODUCT_MISMATCH

Example ​

bash
curl -X POST https://yoursite.com/api/index.php/v1/licensedock/licenses/deactivate \
  -d "license_key=A1B2C3D4-E5F6A7B8-C9D0E1F2-A3B4C5D6" \
  -d "identifier=example.com" \
  -d "product_id=42"

Response ​

Success (200) ​

json
{
  "data": {
    "status": "deactivated",
    "license_key": "A1B2C3D4-E5F6A7B8-C9D0E1F2-A3B4C5D6",
    "identifier": "example.com",
    "activations_used": 4
  }
}

Errors ​

CodeHTTPWhen
INVALID_REQUEST400Missing license_key or identifier, or identifier over 255 characters
LICENSE_INVALID403Key doesn't exist, or its status isn't active
PRODUCT_MISMATCH403product_id was sent and the key doesn't cover it
ACTIVATION_NOT_FOUND404No activation matches that identifier on this license
RATE_LIMITED429Per-IP or per-key limit hit. See Rate Limiting
INTERNAL_ERROR500Unexpected server failure

A suspended, revoked or cancelled license can't remove activations through the API. A license that is active but past its expiry date still can.

Identifier Normalisation ​

See API conventions.

Joomla Extensions by Contona