Create or update a tenant setting

curl --request PUT \
  --url https://api.royalti.io/tenant/settings/{name} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "value": "https://your-domain.com/webhooks/royalti"
}
'

{
  "message": "Webhook setting updated successfully",
  "setting": {
    "name": "webhook-config.url",
    "value": "https://your-domain.com/webhooks/royalti"
  },
  "webhook": {
    "config": {
      "url": "<string>",
      "enabledEvents": [
        "<string>"
      ],
      "enableSignatureValidation": true,
      "secretToken": "<string>",
      "retryAttempts": 123,
      "timeoutMs": 123,
      "customHeaders": {},
      "isActive": true,
      "requireHttps": true,
      "userAgent": "<string>"
    },
    "metrics": {
      "lastDeliveryAttempt": "2023-11-07T05:31:56Z",
      "lastSuccessfulDelivery": "2023-11-07T05:31:56Z",
      "lastFailedDelivery": "2023-11-07T05:31:56Z",
      "consecutiveFailures": 123,
      "totalDeliveries": 123,
      "totalSuccesses": 123,
      "totalFailures": 123,
      "averageResponseTimeMs": 123,
      "isHealthy": true,
      "healthScore": 123,
      "errorRate": 123
    }
  }
}

{
  "status": "error",
  "message": "Retry attempts must be a number between 0 and 10"
}

{
  "status": "error",
  "message": "Retry attempts must be a number between 0 and 10"
}

{
  "status": "error",
  "message": "Retry attempts must be a number between 0 and 10"
}

PUT

tenant

settings

{name}

curl --request PUT \
  --url https://api.royalti.io/tenant/settings/{name} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "value": "https://your-domain.com/webhooks/royalti"
}
'

{
  "message": "Webhook setting updated successfully",
  "setting": {
    "name": "webhook-config.url",
    "value": "https://your-domain.com/webhooks/royalti"
  },
  "webhook": {
    "config": {
      "url": "<string>",
      "enabledEvents": [
        "<string>"
      ],
      "enableSignatureValidation": true,
      "secretToken": "<string>",
      "retryAttempts": 123,
      "timeoutMs": 123,
      "customHeaders": {},
      "isActive": true,
      "requireHttps": true,
      "userAgent": "<string>"
    },
    "metrics": {
      "lastDeliveryAttempt": "2023-11-07T05:31:56Z",
      "lastSuccessfulDelivery": "2023-11-07T05:31:56Z",
      "lastFailedDelivery": "2023-11-07T05:31:56Z",
      "consecutiveFailures": 123,
      "totalDeliveries": 123,
      "totalSuccesses": 123,
      "totalFailures": 123,
      "averageResponseTimeMs": 123,
      "isHealthy": true,
      "healthScore": 123,
      "errorRate": 123
    }
  }
}

{
  "status": "error",
  "message": "Retry attempts must be a number between 0 and 10"
}

{
  "status": "error",
  "message": "Retry attempts must be a number between 0 and 10"
}

{
  "status": "error",
  "message": "Retry attempts must be a number between 0 and 10"
}

Description

validated per-field (see the field table above) and the response includes the freshly assembled webhook config alongside the updated setting. Rejects names starting with distro- (managed separately via /distro/settings). Authorization:

Required role: admin or higher

Code Examples

const response = await fetch('https://api.royalti.io/tenant/settings/{name}', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
});

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

import requests

response = requests.put(
  'https://api.royalti.io/tenant/settings/{name}',
  json={}
)

data = response.json()
print(data)

curl -X PUT https://api.royalti.io/tenant/settings/{name} \
  -H "Content-Type: application/json" \
  -d '{}'

Authorizations

Authorization

string

header

required

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

Path Parameters

name

string

required

Setting name, e.g. webhook-config.url, webhook-config.retryAttempts

Body

application/json

value

any

required

New value for the setting. Type depends on the setting name — see the field table above.

Response

Setting updated successfully

message

string

Example:

"Webhook setting updated successfully"

setting

object

Show child attributes

webhook

object

Returned only when requested via ?include=webhook/?assembleWebhook=true, or after a PUT to a webhook-config.* setting

Show child attributes

​Description

​Code Examples

Authorizations

Path Parameters

Body

Response

Description

Code Examples