Kontakte/Abonnenten verwalten

Kontakte importieren

Importe dienen der massenhaften Verarbeitung deiner Abonnenten.

Die Abonnenten werden beim Import nicht sofort im System angelegt. Beim Aufruf der Funktionen wird ein asynchroner Hintergrund-Job in eine Warteschlange gestellt, der die Verarbeitung übernimmt, sobald er von der Job-Queue abgearbeitet wird.

Abhängig von der Datenmenge solltest du für Folgeaktionen – wie z. B. den Versand eines Mailings – ausreichend zeitlichen Puffer einplanen.

Den Status des Import-Jobs findest du in der Benutzeroberfläche unter Abonnenten > Import

ImportRecipients

Importiert Empfängerdaten aus einem Array. Verwende diese Funktion, wenn du eine kleine Anzahl von Abonnenten (bis zu 2000 je Aufruf) importieren möchtest.

Die Importarten entsprechen den Modi, die auch über die Benutzeroberfläche verfügbar sind:

Importart (Parameter "mode")	Beschreibung
add	Hinzufügen
replace	Ersetzen
update	Aktualisieren
update_add	Aktualisieren und Hinzufügen (empfohlen)
update_intersect	Aktualisieren - fehlende Empfänger aus Liste löschen
update_add_intersect	Aktualisieren und Hinzufügen - fehlende Empfänger aus Liste löschen

ImportRecipientsBySetupId

Importiert Empfängerdaten auf Grundlager der Einstellungen eines Importsetups aus einer CSV-Datei oder einem Base64-kodiertem JSON-String.

Durch das Ansprechen eines Importsetups kannst du nachgelagerte Aufgaben wie den Dubletten- oder Abmeldeabgleich direkt mitausführen lassen.

Die Dublettenabgleichssetups findest du unter Setups > Dublettenabgleichssetup

Die Funktion nimmt die Daten direkt aus einer CSV-Datei (über eine URL) entgegen.
Alternativ kannst du die Daten auch als Base64-kodierten JSON-String übergeben.

ImportRecipientsFromFile

Importiert Empfängerdaten aus einer CSV-Datei oder aus einem Base64-kodiertem JSON-String.

Die Funktion nimmt die Daten direkt aus einer CSV-Datei (über eine URL) entgegen

Alternativ kannst du die Daten auch als Base64-kodierten JSON-String übergebe

FtpImportRecipients

Importiert Empfängerdaten aus einer CSV-Datei von einem (S)FTP-Server.

Kontakte aktualisieren

Es stehen dir Funktionen zum Aktualisieren einzelner Abonnenten sowie mehrerer Abonnenten gleichzeitig zur Verfügung.

UpdateRecipientById

Das Profil eines Abonntenten anhand der Abonnenten-ID aktualisieren. Es lassen sich die Werte der Abonnentenfelder sowie die Listenzugehörigkeiten aktualisieren.

UpdateRecipientByIdAndCode

Das Profil eines Abonntenten anhand der Abonnenten-ID und des Abonnenten-Codes aktualisieren. Es lassen sich die Werte der Abonnentenfelder sowie die Listenzugehörigkeiten aktualisieren.

UpdateRecipients

Das Profil mehrer Abonntenten anhand der Abonnenten-ID aktualisieren. Es lassen sich die Werte der Abonnentenfelder sowie die Listenzugehörigkeiten aktualisieren.

Kontakte löschen

Es stehen dir Funktionen zum Löschen einzelner Abonnenten sowie mehrerer Abonnenten gleichzeitig zur Verfügung.

DeleteRecipientById

Löscht einen einzelnen Kontakt anhand der Abonnenten-ID.

DeleteRecipients

Löscht mehrere Kontakt. Die Ids der zu löschenden Kontakte werden als Array übergeben.

Es können maximal 1000 Abonnenten je Aufruf gelöscht werden.

Kontakte abrufen und exportieren

Hier ist ein Auszug der wichtigsten Funktionen zum Abruf von Abonnentendaten aufgeführt. Es gibt noch weitere Funktionen, beispielsweise zur Ermittlung von Abonnenten-Ids anhand bestimmter Kriterien.

GetRecipientByFieldIdAndValue

Liefert die Daten eines einzelnen Abonnenten anhand einer übermittelten Abonnentenfeld-ID und des zugehörigen Werts. Die Suche lässt sich optional auf eine bestimmte Liste einschränken.
Diese Funktion ist nützlich, wenn Abonnenten ein eindeutiges Merkmal wie z. B. eine CRM-ID, Kundennummer oder ähnliches besitzen.

Wird mehr als ein Abonnent mit der übermittelten Abonntenfeld-ID/Wert-Kombination gefunden, gibt die Funktion einen Fehler zurück.

GetRecipientById

Liefert die Daten eines einzelnen Abonnenten anhand der übermittelten Abonnenten-ID.

GetRecipientFieldsById

Liefert alle Abonnentenfeld-IDs und dazugehörige Werte eines einzelnen Abonntenten anhand der übergebenen Abonnenten-ID.

GetRecipientFieldsByIdAndCode

Liefert alle Abonnentenfeld-IDs und dazugehörige Werte eines einzelnen Abonntenten anhand der Abonnenten-ID und des Abonnenten-Code.

GetRecipientListsById

Liefert alle Abonnentenlisten-Ids eines einzelnen Abonntenten anhand der übergebenen Abonnenten-ID.

GetRecipients

Liefert die Daten mehrerer Abonnenten. Es werden die Felder und Abonnentenlisten zurückgegeben.

Die Abonnenten lassen sich nach folgenden Kriterien filtern:

Abonnentenliste-ID (listId)
Zielgruppe (targetgroupId)
Erstellungsdatum bis (startCreateDate)
Erstellungsdatum ab (endCreateDate)

Weiterhin kann der Anfangsdatensatz (start) und die maximale Anzahl an Einträgen (limit) hinterlegt werden, um durch eine große Anzahl von Abonnenten zu paginieren.

Die Anzahl der abzurufenden Datensätze wirkt sich auf die Geschwindigkeit des Funktionsaufrufes aus. Die Anzahl der je Call maximal abrufbaren Abonnenten ist von der Anzahl der Abonnentenfelder bzw. Inhalte sowie der Listen abhängig. Wir empfehlen, maximal 2000 Abonnenten je Call abzurufen.

GetRecipientsByEmailId

Liefert die Daten aller Abonnenten, anhand eines Mailings.

Die Abonnenten lassen sich mit dem Advanced-Parameter status filtern. Je nach Mailing-Zustand gibt es unterschiedliche Status:

Vor dem Versand

Status	Beschreibung
blacklisted	E-Mail-Adresse auf Blacklist
retained	E-Mail-Adresse auf Liste der zurückgehaltenen E-Mail-Adressen
complained	E-Mail-Adresse auf Beschwerdeliste
excluded	Abo-Feldwert auf Ausschlussliste
invalid	E-Mail-Adresse logisch falsch

Personalisierungsphase

Status	Beschreibung
ready	Personalisierung anstehend
processing	Personalisierung läuft
done	Personalisierung abgeschlossen

Nach dem Versand

Status	Beschreibung
sent	Zustellung erfolgreich
bounced	Zustellung aufgrund eines Bounces nicht erfolgreich
delayed	Zustellung verzögert – der empfangende Mailserver hat die Annahme der Nachricht nicht sofort bestätigt (z. B. Greylisting oder temporäre Probleme beim Empfänger). Die Zustellung wird erneut versucht.

GetRecipientsByEmailIdAndLinkId

Alle Empfänger abrufen, die auf einen bestimmten Link in der angegebenen E-Mail geklickt haben.

GetRecipientsByEmailIdAndOpening

Alle Empfänger abrufen, die die angegebene E-Mail geöffnet haben.

GetRecipientsByFieldIdAndValue

Passenden Empfänger für den angegebenen Wert eines einzelnen Abonnentenfeldes abrufen.

GetRecipientsByFieldIdAndValues

Passenden Empfänger für die angegebenen Werte eines einzelnen Abonnentenfeldes abrufen.

GetRecipientsByOptinsetupId

Alle Empfänger abrufen, die sich über das angegebene Anmeldesetup angemeldet haben.

ExportRecipients

Gibt alle Empfänger zurück, die der angegebenen Abonnentenliste zugeordnet sind.

Diese Funktion gibt nur die Felder zurück.