tenants

Update

Partial update of tenant configuration (branding, URLs, join policy, status, etc.) — only fields present in the body change. Behind a manage-level resource check (tenant admins may update their own tenant; platform admins any tenant). status, web3_enabled, metered_sends_enabled, auth_provider and privy_app_id are platform-only: a tenant admin who CHANGES one gets 403 forbidden (sending the current value back is allowed). metadata writes the ui section only (portal presentation such as navigation bars): ui replaces the stored ui, null removes it, other stored keys are untouched, and any other key is 400 unless it echoes the stored value; ui is capped at 32 KiB.

patch/tenants/{id}

Request

  • Base URL: https://api.instruxi.dev/api/v1/enforcer
  • URL: https://api.instruxi.dev/api/v1/enforcer/tenants/{id}
  • Auth: one of:
    • API key in header Authorization
    • API key in header X-API-Key

Path parameters

idstring required

id

Request body

account_abstractionboolean
app_urlstring
auth_providerstring
banner_urlstring
descriptionstring
logo_urlstring
metadataobject

Metadata writes the tenant's ui section only (portal presentation: navigation bars, theme). It MERGES: ui replaces the stored ui, a null ui removes it, and every other stored key is left alone. Any other key is refused (400) unless it echoes the stored value, so a client that round-trips the whole bag still works and nobody writes feature flags through a branding endpoint. ui is capped at 32 KiB.

metered_sends_enabledboolean
namestring
payment_link_urlstring
privy_app_idstring
self_join_policy'open' | 'invite_only'
status'active' | 'inactive' | 'suspended'
thumbnail_urlstring
wallet_providerstring
web3_enabledboolean

Web3Enabled / MeteredSendsEnabled are the two web3 gates. They are validated as a PAIR against their effective values, so turning web3 off while metering is already on is refused just like turning metering on while web3 is off — the same illegal state reached from either direction.

Response

OK

successboolean

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.