Update channel settings
Patches the STR channel settings. Only the provided fields are updated; absent fields keep their current value. At least one field must be provided. Setting the participant ISPB requires an explicit 8-digit value (placeholders such as 00000000 are rejected). Idempotent — replaying the same X-Idempotency key with the same body returns the cached response.
Authorizations
JWT bearer token issued by the identity provider.
Headers
Idempotency key (primary).
Idempotency key (legacy alias for X-Idempotency).
Idempotency key TTL in seconds (overrides the configured default).
Body
Optional notification delivery mode to set: WEBHOOK, EVENT (streaming), or BOTH; left unchanged when omitted.
"WEBHOOK"
Optional participant ISPB to set, the 8-digit BACEN institution identifier; left unchanged when omitted.
8^[0-9]{8}$"12345678"
Optional client-supplied settings metadata to merge; sensitive keys are redacted on read.
Response
OK
SPB channel connectivity status: CONNECTED or PENDING_CONFIGURATION.
"CONNECTED"
Notification delivery mode: WEBHOOK, EVENT (streaming), or BOTH.
"WEBHOOK"
Participant ISPB the settings belong to, the 8-digit BACEN institution identifier.
8^[0-9]{8}$"12345678"
Configured webhook endpoints that receive STR notifications.
Whole days remaining until the active certificate expires; absent when no certificate is configured.
365
UTC RFC 3339 expiry timestamp of the active ICP-Brasil certificate; absent when no certificate is configured.
"2027-05-04T18:30:00Z"
Client-supplied settings metadata; sensitive keys and values are redacted before being returned.
Embedded readiness summary; present only when the readiness summary is available.

