List suppression reasons

Starts with opt_out, deceased, complaint and other; archived reasons are flagged and can no longer be chosen.

Scope items.read

Returns

1 fields of the 200 answer

dataarray of objectsrequired

5 fields

keystringrequired

labelstringrequired

sourceenumrequired

platformorganisation

sortOrderintegerrequired

archivedbooleanrequired

Responses

200Success

401Authentication required or API key invalid

403Permission or scope missing, organisation suspended

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

otherError (RFC 9457 problem details)

Request

curl https://api.postbuddy.nl/v1/suppression-reasons \
  -H "Authorization: Bearer $POSTBUDDY_API_KEY"

import { PostBuddyClient } from '@postbuddy/sdk';

const client = new PostBuddyClient({ apiKey: process.env.POSTBUDDY_API_KEY! });

const result = await client.suppressionReasons.list();

import os
from postbuddy import Client

client = Client(os.environ["POSTBUDDY_API_KEY"])

result = client.suppression_reasons.list()

Response

{
  "data": [
    {
      "key": "first_name",
      "label": "First name",
      "source": "platform",
      "sortOrder": 1,
      "archived": false
    }
  ]
}