Skip to main content
PUT
Activate or deactivate an addon (preferred toggle endpoint)
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

PUT /addons//toggle If the tenant has no TenantAddon row yet, creates one with default settings and active: true (ignores the request active value in that case). Otherwise updates the existing row’s active flag. Functionally identical to DELETE /addons/{addonId} — both call the same toggleTenantAddon handler; this is the semantically clearer route to use. Authorization:
  • Required role: admin or higher

Code Examples

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Path Parameters

addonId
enum<string>
required
Available options:
distro,
payment_requests,
publisher

Body

application/json
active
boolean
required

Response

Addon activated or deactivated

success
boolean
Example:

true

message
string
data
object

A tenant's activation record for one addon (TenantAddon model, composite PK TenantId + AddonName).