Skip to main content
POST
Send message to BCB

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
body
string

Message body. Non-blank, at most 102400 characters (100 KB).

Required string length: 1 - 102400
Example:

"Prezados, gostaríamos de esclarecer..."

destination
string

BCB destination code override (e.g. DEINF). At most 50 characters.

Maximum string length: 50
Example:

"DEINF"

inReplyToMailId
string<uuid>

Optional UUID of a received mail being replied to. Omit the key when not replying: an empty string is not a UUID and is refused.

Example:

"550e8400-e29b-41d4-a716-446655440000"

keywords
string[] | null

Optional PalavrasChave list: at most 10 entries, each at most 100 characters.

Maximum array length: 10
Maximum string length: 100
Example:
subject
string

Message subject. Non-blank, at most 500 characters.

Required string length: 1 - 500
Example:

"Consulta sobre Resolução 4.966"

Response

Created

bcbConfirmationId
string | null
required
Example:

"BCB-2026-0311-001234"

idempotencyKey
string
required
Example:

"send-msg-2026-03-30-001"

messageId
string
required
Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

sentAt
string
required
Example:

"2026-03-30T14:00:00Z"

status
string
required
Example:

"CONFIRMED"