Update platform setting

PATCHhttps://app.speybooks.com/api/v1/admin/settings/{key}

Update a single platform setting by key. The request body is a JSON object with one value key: { "value": <any_type> }. The value may be a string, number, boolean, array, or object, and is stored as supplied. Returns 404 if the key does not exist. The acting admin is recorded against the change.

Records a SETTING_UPDATED action in the audit log.

Path parameters

keystringrequired

Setting key (e.g. maintenance_mode, early_access_enabled).

Response

200Setting updated.

Error codes

400Invalid setting value.

404Setting key not found.

RequestPATCH/v1/admin/settings/{key}curl

curl -X PATCH https://api.speybooks.com/v1/admin/settings/maintenance_mode \
  -H "Authorization: Bearer <admin-token>" \
  -H "Content-Type: application/json" \
  -d '{"value": true}'

Response200

{
  "success": true
}