PATCH/v1/suppression-reasons/{key}

Rename, reorder or archive a suppression reason

At least one reason stays active.

Scope suppressions.manage

Path parameters

keystringrequired

Body

labelstringmin length 1max length 80

sortOrderintegermin 0max 10000

archivedboolean

Returns

5 fields of the 200 answer

keystringrequired

labelstringrequired

sourceenumrequired

platformorganisation

sortOrderintegerrequired

archivedbooleanrequired

Responses

200Success

401Authentication required or API key invalid

403Permission or scope missing, organisation suspended

404Not found

422Validation failed

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

otherError (RFC 9457 problem details)

curl -X PATCH https://api.postbuddy.nl/v1/suppression-reasons/obj_01J9Y2K8QF4T6W8Z0B2D4F6H8K \ -H "Authorization: Bearer $POSTBUDDY_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "label": "First name", "sortOrder": 1, "archived": false }'

import { PostBuddyClient } from '@postbuddy/sdk'; const client = new PostBuddyClient({ apiKey: process.env.POSTBUDDY_API_KEY! }); const result = await client.suppressionReasons.update('obj_01J9Y2K8QF4T6W8Z0B2D4F6H8K', { body: { label: 'First name', sortOrder: 1, archived: false, }, });

import os from postbuddy import Client client = Client(os.environ["POSTBUDDY_API_KEY"]) result = client.suppression_reasons.update("obj_01J9Y2K8QF4T6W8Z0B2D4F6H8K", { "label": "First name", "sortOrder": 1, "archived": False, })

{ "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" } ] }