Module
Newsletter
Newsletter sind langlebige Kommunikations-Kanäle (vs. einmalige Kampagnen). Pro Newsletter gibt es Subscriber-Listen und periodische Editionen.
Resources
| Resource | Pfad | Permission-Präfix | Sequenz |
|---|---|---|---|
| Listen | /api/v1/newsletter_lists | newsletter_list | — |
| Subscriber | /api/v1/newsletter_subscribers | newsletter_subscriber | — |
| Templates | /api/v1/newsletter_templates | newsletter_template | — |
| Editionen / Aussendungen | /api/v1/newsletter_campaigns | newsletter_campaign | EDIT- |
Eine newsletter_list ist der langlebige Kanal mit Subscriber-Liste und
Default-Template. Jede konkrete Aussendung legt eine newsletter_campaign an.
Schemas
List
newsletter_lists4 Permissions
Schema for newsletter subscriber lists (static or dynamic segment)
name string erforderlich
1–200 Zeichen
description string optional
nullable
doubleOptInEnabled boolean optional
Default: true
subscriberCount integer optional
≥ 0Default: 0
type string optional
Werte
STATICSEGMENT Default: "STATIC"
segmentFilters object[] optional
nullable
field string erforderlich
Werte
emailfirstNamelastNamecompanystatusconsentSourcetagscustomFieldsbounceCountleadScorecreatedAtconsentTimestamplastOpenedAtlastClickedAt operator string erforderlich
Werte
equalsnot_equalscontainsnot_containsstarts_withends_withgreater_thanless_thanbetweeninnot_inexistsnot_existsbeforeafter value any erforderlich
segmentLogic string optional
Werte
ANDOR Default: "AND"nullable
lastRecalculatedAt datetime optional
nullable
estimatedCount integer optional
≥ 0nullable
tags string[] optional
nullable
Keine Felder passen zum Filter.
Subscriber
newsletter_subscribers4 Permissions
Schema for newsletter subscriber records with DSGVO consent tracking
listId uuid erforderlich
email email erforderlich
max 255 Zeichen
partyId uuid optional
nullable
contactPartyId uuid optional
nullable
firstName string optional
max 200 Zeichennullable
lastName string optional
max 200 Zeichennullable
company string optional
max 200 Zeichennullable
status string erforderlich
Werte
PENDINGACTIVEUNSUBSCRIBEDBOUNCEDCOMPLAINED consentSource string optional
Werte
MANUALIMPORTFORMAPICRM_SYNC nullable
consentIp string optional
max 100 Zeichennullable
consentTimestamp datetime optional
nullable
doubleOptInSentAt datetime optional
read-onlynullable
doubleOptInConfirmedAt datetime optional
read-onlynullable
doubleOptInToken string optional
max 200 Zeichenread-onlynullable
unsubscribedAt datetime optional
nullable
unsubscribeReason string optional
max 500 Zeichennullable
bounceCount integer optional
≥ 0Default: 0read-only
lastBounceAt datetime optional
read-onlynullable
bounceType string optional
Werte
SOFTHARD read-onlynullable
lastOpenedAt datetime optional
nullable
lastClickedAt datetime optional
nullable
openCount integer optional
≥ 0Default: 0
clickCount integer optional
≥ 0Default: 0
leadScore integer optional
≥ 0Default: 0
leadScoreUpdatedAt datetime optional
nullable
customFields object optional
nullable
tags string[] optional
nullable
Keine Felder passen zum Filter.
Template
newsletter_templates4 Permissions
Schema for reusable newsletter email templates
name string erforderlich
1–200 Zeichen
description string optional
nullable
category string optional
Werte
GENERALPRODUCT_UPDATEMAINTENANCESECURITY_ALERTWELCOMECUSTOM Default: "GENERAL"
subject string erforderlich
1–500 Zeichen
htmlContent string erforderlich
min 1 Zeichen
textContent string optional
nullable
tiptapContent object optional
nullable
previewImageUrl string optional
nullable
variables string[] optional
Default: []
isDefault boolean optional
Default: false
tags string[] optional
nullable
Keine Felder passen zum Filter.
Campaign
newsletter_campaigns4 Permissions
Schema for newsletter email campaigns with A/B testing support
name string erforderlich
1–200 Zeichen
description string optional
nullable
status string erforderlich
Werte
DRAFTSCHEDULEDSENDINGPAUSEDSENTCANCELLEDFAILED Default: "DRAFT"
templateId uuid optional
nullable
listIds uuid[] erforderlich
min 1 Items
excludeListIds uuid[] optional
Default: []
subject string erforderlich
1–500 Zeichen
htmlContent string erforderlich
min 1 Zeichen
textContent string optional
nullable
tiptapContent object optional
nullable
fromName string optional
max 200 Zeichennullable
fromEmail email optional
nullable
replyTo email optional
nullable
emailAccountId uuid optional
nullable
scheduledAt datetime optional
nullable
sentAt datetime optional
nullable
completedAt datetime optional
nullable
abTest object optional
nullable
enabled boolean optional
Default: false
testType string optional
Werte
SUBJECTCONTENTFROM_NAME variantB object optional
nullable
subject string optional
max 500 Zeichennullable
htmlContent string optional
nullable
fromName string optional
max 200 Zeichennullable
testPercentage integer optional
5 – 50Default: 20
winnerCriteria string optional
Werte
OPEN_RATECLICK_RATE Default: "OPEN_RATE"
waitHours integer optional
1 – 72Default: 4
winner string optional
Werte
AB nullable
variantAStats object optional
variantBStats object optional
testStartedAt datetime optional
nullable
winnerPickedAt datetime optional
nullable
stats object optional
nullable
totalRecipients integer optional
≥ 0Default: 0
sent integer optional
≥ 0Default: 0
delivered integer optional
≥ 0Default: 0
opened integer optional
≥ 0Default: 0
uniqueOpened integer optional
≥ 0Default: 0
clicked integer optional
≥ 0Default: 0
uniqueClicked integer optional
≥ 0Default: 0
bounced integer optional
≥ 0Default: 0
unsubscribed integer optional
≥ 0Default: 0
complained integer optional
≥ 0Default: 0
failed integer optional
≥ 0Default: 0
tags string[] optional
nullable
Keine Felder passen zum Filter.
Lifecycle einer Aussendung
draft → scheduled → sending → sentSobald eine Edition versendet wird, fließen pro Empfänger:
- Open-Pixel-Aufrufe (Public-Endpoint, parst die
editionIdaus der URL) - Click-Tracking (Public-Endpoint, redirected nach Logging)
- Unsubscribe-Klicks (Public-Endpoint, deaktiviert die Subscription)
Diese Public-Endpoints leben unter /api/v1/public/newsletter/... — siehe
Public Endpoints.
Verwandt
- Konventionen
- Kampagnen — einmaliger Versand
- Public Endpoints — Open-/Click-/Unsubscribe-Tracking