API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · email_suppressions

Email Suppression Schema

Schema-ID
email_suppression
Collection
email_suppressions
Permissions
  • Lesenemail_suppression_view
  • Anlegenemail_suppression_create
  • Ändernemail_suppression_edit
  • Löschenemail_suppression_delete

Felder

Email Suppression Schema

email_suppressions4 Permissions

Deliverability suppression list (hard bounces, complaints, manual blocks). ADR 0290.

emailstringerforderlich

Lowercased, trimmed email address.

max 320 Zeichen
reasonstringerforderlich
Werte
HARD_BOUNCECOMPLAINTMANUALUNSUBSCRIBE_ALL
read-only
scopestringoptional
Werte
MARKETINGALL
Default: "MARKETING"
bounceTypestringoptional
Werte
SOFTHARDTRANSIENTPERMANENT
read-onlynullable
sourcestringoptional

Origin of the entry (e.g. "ses-webhook", "manual", "one-click-unsubscribe").

max 64 Zeichenread-onlynullable
diagnosticCodestringoptional
max 1000 Zeichenread-onlynullable
suppressedAtdatetimeoptional
read-onlynullable
partyIduuidoptional
nullable
lastMessageIdstringoptional

SES messageId of the notification that caused the suppression.

max 256 Zeichenread-onlynullable
notesstringoptional
max 500 Zeichennullable

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

  • GET /api/v1/email_suppressions — Liste, paginiert + filterbar
  • GET /api/v1/email_suppressions/<id> — Einzelne Entity
  • POST /api/v1/email_suppressions — Anlegen
  • PATCH /api/v1/email_suppressions/<id> — Teil-Update
  • DELETE /api/v1/email_suppressions/<id> — Soft-Delete
  • GET /api/v1/email_suppressions/<id>/timeline — Audit + Aktivitäten

Suche