Partially update tenant settings

PATCH/v1/tenants/{tenant_id}/settings

Partially updates the enrichment settings for the specified tenant_id using RFC 7396 JSON Merge Patch semantics (media type application/merge-patch+json; application/json is also accepted). For each member: a value sets that setting, JSON null removes it (e.g. {"target_language": null} clears the target language), and an omitted member is left unchanged. The tenant_id is taken from the path, so a request can only ever modify its own tenant's settings. target_language is normalized to a canonical BCP-47 locale (e.g. "en-us" becomes "en-US"); an empty string is rejected (send null to remove it). While a tenant data purge runs for the same tenant_id, this write is rejected with HTTP 409 (code tenant_write_conflict) and may be retried.

Path ParametersExpand Collapse

tenant_id: string

minLength1

maxLength255

Body ParametersExpand Collapse

target_language: optional string

Target BCP-47 locale to translate into; normalized to a canonical form (e.g. "en-us" becomes "en-US"). Send null to remove it; omit to leave it unchanged. An empty string is rejected.

maxLength35

ReturnsExpand Collapse

settings: object { target_language }

Tenant-scoped enrichment configuration. Fields are optional; absent fields use server defaults.

target_language: optional string

Normalized BCP-47 locale (e.g. "en-US") that language enrichment translates feedback records and topic labels into. Absent or empty means not configured.

maxLength35

tenant_id: string

Tenant ID the settings belong to

minLength1

maxLength255

Partially update tenant settings

curl http://localhost:8080/v1/tenants/$TENANT_ID/settings \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $HUB_API_KEY" \
    -d '{
          "target_language": "de-DE"
        }'

{
  "tenant_id": "org-123",
  "settings": {
    "target_language": "de-DE"
  }
}

Returns Examples

{
  "tenant_id": "org-123",
  "settings": {
    "target_language": "de-DE"
  }
}