Activation Endpoints #
Endpoints for activating and deactivating site licenses.
Activate Site (ID-Based) #
| Property | Value |
|---|---|
| Method | POST |
| Endpoint | /licenses/{id}/activate |
| Auth | None (public) |
Request Body:
| Field | Type | Required | Description |
|---|---|---|---|
| site_url | string | Yes | URL of the site to activate |
| product_id | integer | Yes | Product ID the license belongs to (required v2.0.0) |
| customer_email | string | No | Customer email to capture (new v2.0.0) |
Response:
| Field | Description |
|---|---|
| success | true |
| activation_id | The new activation record ID |
| email_notice | Present if customer_email was provided and stored (new v2.0.0) |
Activate Site (Key-Based) — Recommended #
| Property | Value |
|---|---|
| Method | POST |
| Endpoint | /licenses/activate |
| Auth | None (public) |
| Added | v1.2.0 |
This endpoint accepts a license key directly without requiring an internal license ID lookup. This is the recommended activation endpoint for client software integrations.
Request Body:
| Field | Type | Required | Description |
|---|---|---|---|
| license_key | string | Yes | The license key |
| site_url | string | Yes | URL of the site to activate |
| product_id | integer | Yes | Product ID the license belongs to (required v2.0.0) |
| customer_email | string | No | Customer email to capture (new v2.0.0) |
Response:
| Field | Description |
|---|---|
| success | true |
| activation_id | The new activation record ID |
| email_notice | Present if customer_email was captured (new v2.0.0) |
Deactivate Site (ID-Based) #
| Property | Value |
|---|---|
| Method | POST |
| Endpoint | /licenses/{id}/deactivate |
| Auth | None (public) |
Request Body:
| Field | Type | Required | Description |
|---|---|---|---|
| site_url | string | No | URL to deactivate (optional — if omitted, deactivates any single activation for the license) |
| product_id | integer | Yes | Product ID the license belongs to (required v2.0.0) |
Deactivate Site (Key-Based) — Recommended #
| Property | Value |
|---|---|
| Method | POST |
| Endpoint | /licenses/deactivate |
| Auth | None (public) |
| Added | v1.2.0 |
Request Body:
| Field | Type | Required | Description |
|---|---|---|---|
| license_key | string | Yes | The license key |
| site_url | string | No | URL to deactivate (optional — if omitted, deactivates any single activation for the key) |
| product_id | integer | Yes | Product ID the license belongs to (required v2.0.0) |
Response:
| Field | Description |
|---|---|
| success | true |
| message | Confirmation message |
Check-in #
| Property | Value |
|---|---|
| Method | POST |
| Endpoint | /activations/check-in |
| Auth | None (public) |
Updates last-seen timestamp for an activation.
Request Body:
| Field | Type | Required | Description |
|---|---|---|---|
| license_key | string | Yes | The license key |
| site_url | string | Yes | Site URL performing the check-in |
| product_id | integer | Yes | Product ID (required v2.0.0) |
Verify Activation #
| Property | Value |
|---|---|
| Method | POST |
| Endpoint | /activations/verify |
| Auth | None (public) |
Verifies an activation is still valid (license not expired/suspended, product matches).
Request Body:
| Field | Type | Required | Description |
|---|---|---|---|
| license_key | string | Yes | The license key |
| site_url | string | Yes | Site URL to verify |
| product_id | integer | Yes | Product ID (required v2.0.0) |