Skip to content

Corgi BankDocumentation

OpenAPI

Create a notification suppression

POST/notification-suppressions

Record a delivery block or consent-backed release

Headers

Idempotency-KeystringOptional

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

acceptedbooleanRequired

actionstringRequired

addressstringRequired

channelstringRequired

evidencestringRequired

reasonstringRequired

Returns

201 Created

The Notification Suppression object.

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503

Request

curl -X POST 'https://api.dev.bank.corgi.com/notification-suppressions' \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "accepted": false,
    "action": "string",
    "address": "string",
    "channel": "string",
    "evidence": "string",
    "reason": "string"
  }'

Response201

{
  "accepted": false,
  "action": "string",
  "actor": "string",
  "address": "string",
  "channel": "string",
  "created_at": "2026-09-17T14:30:00Z",
  "evidence": "string",
  "id": "string",
  "reason": "string"
}