POST/v1/suppressions

Add suppression entries

One address or an array of up to 1,000; addresses are normalised and matched on the delivery point. An entry without categories holds back all mail. Existing entries are reported and widened to the new categories; their reason and note stay.

Scope suppressions.manageIdempotent with a key

Headers

Idempotency-Keystringmax length 255

Up to 255 characters, scoped to the organisation and the endpoint, kept for 24 hours: a repeat with the same body replays the stored response with Idempotent-Replayed: true (API-004).

Returns

2 fields of the 201 answer

createdarray of objectsrequired

12 fields

idstringrequired

namestringrequired

addressLine1stringrequired

addressLine2string or nullrequired

postalCodestringrequired

citystringrequired

countrystringrequired

reasonstringrequired

categoriesarray of stringrequired

sourceenumrequired

manualcsvapi

notestring or nullrequired

createdAtdate-timerequired

existingarray of objectsrequired

12 fields

idstringrequired

namestringrequired

addressLine1stringrequired

addressLine2string or nullrequired

postalCodestringrequired

citystringrequired

countrystringrequired

reasonstringrequired

categoriesarray of stringrequired

sourceenumrequired

manualcsvapi

notestring or nullrequired

createdAtdate-timerequired

Responses

201Success

401Authentication required or API key invalid

403Permission or scope missing, organisation suspended

409A request with this Idempotency-Key is still in progress (idempotency_in_progress)

422Validation failed

429Rate limited for this API key and class; wait Retry-After seconds

otherError (RFC 9457 problem details)

curl -X POST https://api.postbuddy.nl/v1/suppressions \ -H "Authorization: Bearer $POSTBUDDY_API_KEY" \ -H "Idempotency-Key: crm-0062p00001Xyz-signed" \ -H "Content-Type: application/json" \ -d '{ "name": "Welcome card", "addressLine1": "Oudegracht 112", "postalCode": "3511 AX", "city": "Utrecht", "country": "NL" }'

import { PostBuddyClient } from '@postbuddy/sdk'; const client = new PostBuddyClient({ apiKey: process.env.POSTBUDDY_API_KEY! }); const result = await client.suppressions.add({ body: { name: 'Welcome card', addressLine1: 'Oudegracht 112', postalCode: '3511 AX', city: 'Utrecht', country: 'NL', },, idempotencyKey: 'crm-0062p00001Xyz-signed', });

import os from postbuddy import Client client = Client(os.environ["POSTBUDDY_API_KEY"]) result = client.suppressions.add({ "name": "Welcome card", "addressLine1": "Oudegracht 112", "postalCode": "3511 AX", "city": "Utrecht", "country": "NL", }, idempotency_key="crm-0062p00001Xyz-signed")

{ "created": [ { "id": "obj_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "name": "Welcome card", "addressLine1": "Oudegracht 112", "addressLine2": "2nd floor", "postalCode": "3511 AX", "city": "Utrecht", "country": "NL", "reason": "Example", "categories": [ "Example" ], "source": "manual", "note": "Example", "createdAt": "2026-10-16T09:14:02.000Z" } ], "existing": [ { "id": "obj_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "name": "Welcome card", "addressLine1": "Oudegracht 112", "addressLine2": "2nd floor", "postalCode": "3511 AX", "city": "Utrecht", "country": "NL", "reason": "Example", "categories": [ "Example" ], "source": "manual", "note": "Example", "createdAt": "2026-10-16T09:14:02.000Z" } ] }

{ "type": "https://docs.postbuddy.nl/errors/idempotency_in_progress", "title": "Request with this idempotency key in progress", "status": 409, "code": "idempotency_in_progress", "detail": "A request with this Idempotency-Key is still in progress (idempotency_in_progress)", "requestId": "req_01J9Y2K8QF4T6W8Z0B2D4F6H8K" }

{ "type": "https://docs.postbuddy.nl/errors/validation_failed", "title": "Validation failed", "status": 422, "code": "validation_failed", "detail": "Validation failed", "requestId": "req_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "errors": [ { "field": "recipient.postalCode", "code": "invalid_string", "message": "Invalid postal code" } ] }