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

Newsletter Subscriber Schema

Schema-ID
newsletter_subscriber
Collection
newsletter_subscribers
Permissions
  • Lesennewsletter_subscriber_view
  • Anlegennewsletter_subscriber_create
  • Ändernnewsletter_subscriber_edit
  • Löschennewsletter_subscriber_delete

Felder

Newsletter Subscriber Schema

newsletter_subscribers4 Permissions

Schema for newsletter subscriber records with DSGVO consent tracking

listIduuiderforderlich
emailemailerforderlich
max 255 Zeichen
partyIduuidoptional
nullable
contactPartyIduuidoptional
nullable
firstNamestringoptional
max 200 Zeichennullable
lastNamestringoptional
max 200 Zeichennullable
companystringoptional
max 200 Zeichennullable
statusstringerforderlich
Werte
PENDINGACTIVEUNSUBSCRIBEDBOUNCEDCOMPLAINED
consentSourcestringoptional
Werte
MANUALIMPORTFORMAPICRM_SYNC
nullable
consentIpstringoptional
max 100 Zeichennullable
consentTimestampdatetimeoptional
nullable
doubleOptInSentAtdatetimeoptional
read-onlynullable
doubleOptInConfirmedAtdatetimeoptional
read-onlynullable
doubleOptInTokenstringoptional
max 200 Zeichenread-onlynullable
consentDoiTokenstringoptional
max 200 Zeichenread-onlynullable
unsubscribedAtdatetimeoptional
nullable
unsubscribeReasonstringoptional
max 500 Zeichennullable
bounceCountintegeroptional
≥ 0Default: 0read-only
lastBounceAtdatetimeoptional
read-onlynullable
bounceTypestringoptional
Werte
SOFTHARD
read-onlynullable
lastOpenedAtdatetimeoptional
nullable
lastClickedAtdatetimeoptional
nullable
openCountintegeroptional
≥ 0Default: 0
clickCountintegeroptional
≥ 0Default: 0
leadScoreintegeroptional
≥ 0Default: 0
leadScoreUpdatedAtdatetimeoptional
nullable
customFieldsobjectoptional
nullable
tagsstring[]optional
nullable

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

Suche