Skip to main content
PATCH
Update tenant settings

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency
string
requerido

Idempotency key for safe retries

Cuerpo

application/json
aiApiKey
string

AI provider API key, at most 500 characters (send "" to clear).

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
Ejemplo:

"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.

Opciones disponibles:
openai,
anthropic,
gemini,
Ejemplo:

"openai"

aiSystemPrompt
string

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

Maximum string length: 2000
bcbPassword
string

BCB Sisbacen password, at most 255 characters (send "" to clear).

Maximum string length: 255
bcbUsername
string

BCB Sisbacen username, at most 255 characters (send "" to clear).

Maximum string length: 255
defaultDestination
string

Default BCB destination code. At most 50 characters.

Maximum string length: 50
Ejemplo:

"DEINF"

pollingIntervalMinutes
enum<integer>

BCB polling interval in minutes.

Opciones disponibles:
5,
15,
30,
60
Ejemplo:

15

retentionDays
integer<int64>

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

Rango requerido: 1825 <= x <= 36500
Ejemplo:

1825

Respuesta

OK

hasAiApiKey
boolean
requerido
hasBcbCredentials
boolean
requerido
pollingIntervalMinutes
integer<int64>
requerido
Ejemplo:

15

retentionDays
integer<int64>
requerido
Ejemplo:

1825

tenantId
string
requerido
Ejemplo:

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

updatedAt
string
requerido
aiEndpoint
string
aiModel
string
aiProvider
string
aiSystemPrompt
string
defaultDestination
string
Ejemplo:

"DEINF"