Kundenfelder
Kundenfelder (Customer Fields) sind individuell definierbare Datenfelder, die zusätzlich zu den Standard-Feldern von mail2many verwendet werden können. Sie ermöglichen die Speicherung beliebiger zusätzlicher Informationen.
Grundlagen
Kundenfelder werden auf Anfrage für einen Kunden erstellt und können in allen Accounts des Kunden genutzt werden.
Eigenschaften:
- Jedes Feld hat eine eindeutige ID
- Mehrsprachige Namen und Beschreibungen
- Definierter Feldtyp (wo wird es verwendet?)
- Definierter Datentyp (welche Art von Daten?)
Feldtypen
Customer Fields können an verschiedenen Stellen im System verwendet werden:
| Feldtyp | Wert | Beschreibung | Beispiel |
|---|---|---|---|
| Subscriber | 1 | Pro Empfänger | Lieblingsland, VIP‑Status, Kundennummer |
| Account | 2 | Einmal pro Account | Firmenname, Öffnungszeiten |
| Sendung | 3 | Pro Sendung | Campaign‑ID aus Analytics‑Tool |
Datentypen
Kundenfelder unterstützen verschiedene Datentypen:
| Datentyp | Wert | Beispiel |
|---|---|---|
| String | 1 | "Nepal", "VIP" |
| Integer | 2 | 42, 2024 |
| Date | 3 | "2025-03-15" |
| Boolean | 4 | true, false |
| String List | 5 | ["Nepal", "Thailand"], ["Deutschland"] |
| Currency | 6 | "100.24", "42.10" |
Kundenfelder abrufen
Alle Kundenfelder eines Accounts können über die API abgerufen werden:
Endpoint: GET /customerFields
Response:
{
"data": [
{
"objectType": "CustomerField",
"id": 1,
"fieldType": 1,
"type": 1,
"isAvailableForImport": false,
"isAvailableForExport": false,
"isEditable": true,
"translations": {
"de": {"name": "Lieblingsland", "description": null},
"en": {"name": "Favourite country", "description": null}
},
"value": null,
"createdAt": "2024-09-10 14:14:07",
"updatedAt": "2024-09-10 14:14:07"
}
],
"meta": {"include": [], "meta": {}}
}
Wichtige Felder:
fieldType– Gibt an, ob es ein Subscriber‑, Account‑ oder Sendungs‑Feld ist (siehe Tabelle oben)type– Der Datentyp (siehe Tabelle oben)translations– Mehrsprachige Namen und Beschreibungen
Kundenfelder speichern
Subscriber-Felder
Subscriber‑Felder werden im customerFields-Objekt beim Erstellen oder Aktualisieren eines Empfängers übergeben:
Endpoints:
POST /subscribersPUT /subscribers/{id}POST /subscribers/upsertPOST /subscribers/register
Beispiel:
Angenommen, folgende Kundenfelder existieren:
- Lieblingsland (string)
- Anzahl gebuchter Reisen (integer)
- Letzte Reise (date)
- VIP-Abonnent (boolean)
{
"email": "florian.reichart@atrivio.de",
"customerFields": {
"1": "Nepal",
"2": 2,
"3": "2018-06-01",
"4": true
}
}
Die Schlüssel im customerFields-Objekt sind die IDs der Kundenfelder. Die Werte müssen dem definierten Datentyp entsprechen.
Account-Felder
Account‑Felder werden direkt am Account gespeichert. Details findest du in der Endpoint‑Dokumentation.
Beispiel:
{
"value": "Mein Firmenname"
}
Verwendung in Newslettern
Kundenfelder können wie Variablen in HTML-Newslettern verwendet werden, jedoch mit C statt V:
Syntax:
{{C:<ID>:<DEFAULT>}}
Beispiel (einfache Variable):
{{C:1:Europa}}
→ Gibt das Kundenfeld mit ID 1 aus, falls leer: "Europa"
Beispiel (in Variable Area):
[[A:-:1:-:Hallo {{V:1}} aus {{C:1}}:-:Hallo]]
→ Kombiniert Standard-Variable (V:1 = Anrede) mit Kundenfeld (C:1 = Land)
Weitere Details zur Variablen-Syntax findest du im Kapitel Variablen.