FOformbricks
Tenant Settings

Partially update tenant settings

Changed on

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.

patch/v1/tenants/{tenant_id}/settings

Request

  • Base URL
    http://localhost:8080
  • URL
    http://localhost:8080/v1/tenants/{tenant_id}/settings
  • Auth
    HTTP bearer

Path parameters

tenant_idstring required
Example:org-123

Tenant ID whose settings should be updated. Empty strings and NULL bytes are not allowed.

Request body

target_languagestring nullable

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.

sentiment_enabledboolean nullable

Enable or disable sentiment enrichment. Send null to restore the default (enabled); omit to leave it unchanged.

emotions_enabledboolean nullable

Enable or disable emotion enrichment. Send null to restore the default (enabled); omit to leave it unchanged.

Example request

{
  "target_language": "de-DE"
}

Response

Updated tenant settings

tenant_idstring required

Tenant ID the settings belong to

Example response

{
  "tenant_id": "org-123",
  "settings": {
    "target_language": "en-US",
    "sentiment_enabled": true,
    "emotions_enabled": true
  }
}

Changes

  • 68226bc11827Revision changes
    • info

      added the new optional request property (media type: application/merge-patch+json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the optional property / to the response with the status

  • dbfe2495f58fRevision changes
    • info

      added the new optional request property (media type: application/merge-patch+json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the optional property / to the response with the status