Skip to content

Developer portal

PUT /admin/tenants/{tenant_id}/settings

Merge tenant settings JSON (orgType, salesLed, remediation flags, etc.).

PUT /admin/tenants/{tenant_id}/settingsAuth: admin

Summary

Merge tenant settings JSON (orgType, salesLed, remediation flags, etc.).

Example

Response

{
  "status": "success",
  "tenantId": "acme-bank",
  "settings": {
    "orgType": "mssp",
    "remediationProgramEnabled": true
  }
}

Request body

FieldTypeRequiredDescription
settingsobjectYes

Partial settings object merged into existing tenant settings.

e.g. { "orgType": "mssp", "salesLed": true }

Errors

CodeMeaningTypical causeSuggested fix
404Not foundScan, schedule, share link, or resource id does not exist or expired.Verify id and tenant scope; share links expire per expiresHours.
422Unprocessable entityInvalid payload shape, unsupported scenario, or infeasible constraints.Fix field errors in response detail; relax constraints and retry.
429Too many requestsPer-key rate limit exceeded (default 300 requests per minute) or public endpoint limit.Backoff with jitter; cache results; request higher limit for production.
500Internal server errorUnexpected backend failure; includes requestId in response.Retry with exponential backoff; contact support with requestId if persistent.

See the full errors reference.