POST/v1/suppressions/import

Import suppression entries from a CSV upload

A completed csv upload session; columns are mapped to the recipient fields by header name or through mapping. Rows that cannot be identified are reported by line.

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

Body

uploadIdstringrequiredmin length 1

reasonstringmin length 1max length 60

categoriesarray of stringmax items 50

mappingobject

notestringmax length 500

Returns

7 fields of the 200 answer

rowsintegerrequired

createdintegerrequired

existingintegerrequired

invalidarray of objectsrequired

2 fields

lineintegerrequired

problemsarray of stringrequired

malformedLinesarray of integerrequired

mappingobjectrequired

totalintegerrequired

Responses

200Success

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)

413More than 50,000 rows (import_too_large)

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/import \ -H "Authorization: Bearer $POSTBUDDY_API_KEY" \ -H "Idempotency-Key: crm-0062p00001Xyz-signed" \ -H "Content-Type: application/json" \ -d '{ "uploadId": "upl_01J9Y2K8QF4T6W8Z0B2D4F6H8K" }'

import { PostBuddyClient } from '@postbuddy/sdk'; const client = new PostBuddyClient({ apiKey: process.env.POSTBUDDY_API_KEY! }); const result = await client.suppressions.importCsv({ body: { uploadId: 'upl_01J9Y2K8QF4T6W8Z0B2D4F6H8K', },, idempotencyKey: 'crm-0062p00001Xyz-signed', });

import os from postbuddy import Client client = Client(os.environ["POSTBUDDY_API_KEY"]) result = client.suppressions.import_csv({ "uploadId": "upl_01J9Y2K8QF4T6W8Z0B2D4F6H8K", }, idempotency_key="crm-0062p00001Xyz-signed")

{ "rows": 1, "created": 1, "existing": 1, "invalid": [ { "line": 1, "problems": [ "Example" ] } ], "malformedLines": [ 1 ], "mapping": { "key": "first_name" }, "total": 3 }

{ "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/import_too_large", "title": "Import too large", "status": 413, "code": "import_too_large", "detail": "More than 50,000 rows (import_too_large)", "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" } ] }