Skip to main content
PUT
/
addons
/
{addonId}
/
toggle
Activate or deactivate an addon (preferred toggle endpoint)
curl --request PUT \
  --url https://api.royalti.io/addons/{addonId}/toggle \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "active": true
}'
import requests

url = "https://api.royalti.io/addons/{addonId}/toggle"

payload = { "active": True }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({active: true})
};

fetch('https://api.royalti.io/addons/{addonId}/toggle', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.royalti.io/addons/{addonId}/toggle",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'active' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.royalti.io/addons/{addonId}/toggle"

	payload := strings.NewReader("{\n  \"active\": true\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://api.royalti.io/addons/{addonId}/toggle")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"active\": true\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/addons/{addonId}/toggle")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"active\": true\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "message": "<string>",
  "data": {
    "TenantId": 123,
    "AddonName": "<string>",
    "active": true,
    "settings": {},
    "settingsVersion": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "Addon": {
      "description": "<string>",
      "plans": [
        "<string>"
      ],
      "logo": "<string>",
      "isActive": true
    }
  }
}
{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}
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

const response = await fetch('https://api.royalti.io/addons/example-id/toggle', {
  method: 'PUT',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "active": true
  })
});

const data = await response.json();
console.log(data);

import requests

response = requests.put(
  'https://api.royalti.io/addons/example-id/toggle',
  headers={
    'Authorization': f'Bearer {token}'
  },
  json={"active":true}
)

data = response.json()
print(data)

curl -X PUT https://api.royalti.io/addons/example-id/toggle \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"active":true}'

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).