Skip to main content
POST
Activate an addon for the tenant
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

POST /addons Activates addonName for the tenant: merges default settings with any provided settings, validates them (hand-rolled per-addon checks plus the Phase 7 JSON-schema registry keyed by settingsVersion, which starts at 1 for new rows), writes individual TenantSetting rows ({addonName}-{key}), and creates the TenantAddon record. Fails if the tenant already has this addon. Authorization:
  • Required role: admin or higher

Code Examples

Authorizations

Authorization
string
header
required

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

Body

application/json
addonName
enum<string>
required
Available options:
distro,
payment_requests,
publisher
settings
object

Partial settings merged over the addon's defaults before validation.

Response

Addon activated

success
boolean
Example:

true

message
string
data
object