Skip to main content
POST
Create tenant settings

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency
string
required

Idempotency key for safe retries

Body

application/json
aiApiKey
string

AI provider API key (encrypted at rest). At most 500 characters.

Maximum string length: 500
aiEndpoint
string

AI API endpoint URL, at most 500 characters. Must be HTTPS and must not resolve to a private or loopback address; "" clears it. Those two rules need DNS, so the service applies them and answers 400 BCC-0001.

Maximum string length: 500
aiModel
string

AI model identifier. At most 100 characters.

Maximum string length: 100
Example:

"gpt-4o-mini"

aiProvider
enum<string>

AI provider. One of openai, anthropic, gemini, or "" to clear it (AI not configured). Brand names such as ChatGPT are refused.

Available options:
openai,
anthropic,
gemini,
Example:

"openai"

aiSystemPrompt
string

Per-tenant AI system prompt. At most 2000 characters.

Maximum string length: 2000
bcbPassword
string

BCB Sisbacen password (encrypted at rest). At most 255 characters.

Maximum string length: 255
bcbUsername
string

BCB Sisbacen username (encrypted at rest). At most 255 characters.

Maximum string length: 255
defaultDestination
string

Default BCB destination code. At most 50 characters.

Maximum string length: 50
Example:

"DEINF"

pollingIntervalMinutes
enum<integer>

BCB polling interval in minutes.

Available options:
5,
15,
30,
60
Example:

15

retentionDays
integer<int64>

Mail retention in days (min 1825 = 5y, max 36500 = 100y).

Required range: 1825 <= x <= 36500
Example:

1825

Response

Created

hasAiApiKey
boolean
required
hasBcbCredentials
boolean
required
pollingIntervalMinutes
integer<int64>
required
Example:

15

retentionDays
integer<int64>
required
Example:

1825

tenantId
string
required
Example:

"c7aab4e8-1234-5678-9abc-def012345678"

updatedAt
string
required
aiEndpoint
string
aiModel
string
aiProvider
string
aiSystemPrompt
string
defaultDestination
string
Example:

"DEINF"