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

Newsletter List Schema

Schema-ID
newsletter_list
Collection
newsletter_lists
Permissions
  • Lesennewsletter_list_view
  • Anlegennewsletter_list_create
  • Ändernnewsletter_list_edit
  • Löschennewsletter_list_delete

Felder

Newsletter List Schema

newsletter_lists4 Permissions

Schema for newsletter subscriber lists (static or dynamic segment)

namestringerforderlich
1–200 Zeichen
descriptionstringoptional
nullable
doubleOptInEnabledbooleanoptional
Default: true
subscriberCountintegeroptional
≥ 0Default: 0
requiredConsentCategoriesstring[]optional
Default: []nullable
typestringoptional
STATICSEGMENT
Default: "STATIC"
segmentFiltersobject[]optional
nullable
fieldstringerforderlich
emailfirstNamelastNamecompanystatusconsentSourcetagscustomFieldsbounceCountleadScorecreatedAtconsentTimestamplastOpenedAtlastClickedAt
operatorstringerforderlich
equalsnot_equalscontainsnot_containsstarts_withends_withgreater_thanless_thanbetweeninnot_inexistsnot_existsbeforeafter
valueanyerforderlich
segmentLogicstringoptional
ANDOR
Default: "AND"nullable
lastRecalculatedAtdatetimeoptional
nullable
estimatedCountintegeroptional
≥ 0nullable
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_lists — Liste, paginiert + filterbar
  • GET /api/v1/newsletter_lists/<id> — Einzelne Entity
  • POST /api/v1/newsletter_lists — Anlegen
  • PATCH /api/v1/newsletter_lists/<id> — Teil-Update
  • DELETE /api/v1/newsletter_lists/<id> — Soft-Delete
  • GET /api/v1/newsletter_lists/<id>/timeline — Audit + Aktivitäten

Suche