Sign in
Tenant Settings

Update tenant settings

Creates or replaces the enrichment settings for the specified tenant_id (full replace of the settings object). 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"); send an empty string to clear 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.

put/v1/tenants/{tenant_id}/settings

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

Target BCP-47 locale to translate into; normalized to a canonical form (e.g. "en-us" becomes "en-US"). Send an empty string to clear it.

sentiment_enabledboolean

Enable or disable sentiment enrichment for this tenant. As a full replace, omitting it clears the setting back to the default (enabled).

emotions_enabledboolean

Enable or disable emotion enrichment for this tenant. As a full replace, omitting it clears the setting back to the default (enabled).

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

Changed in 3 of the 35 revisions of this API.5

  • 68226bc118272See the full diff
    • ○

      added the new optional request property emotions_enabled

      new-optional-request-property

    • ○

      added the optional property settings/emotions_enabled to the response with the 200 status

      response-optional-property-added

  • dbfe2495f58f2See the full diff
    • ○

      added the new optional request property sentiment_enabled

      new-optional-request-property

    • ○

      added the optional property settings/sentiment_enabled to the response with the 200 status

      response-optional-property-added

  • 17c77a1a30311See the full diff
    • ○

      endpoint added

      endpoint-added