Synchronisieren

Personen mit campflow synchronisieren

Folge diesem Leitfaden, wenn du mehrere Personendatensätze aus einem bestehenden System importieren und regelmäßig nach campflow spiegeln möchtest.

Wenn du stattdessen lieber Änderungen an einzelnen Personen vornehmen möchtest, sieh dich unter Einzelne Personen um.

Übersicht

Die API stellt dir einen einzigen Endpunkt bereit, an den du alle neuen Personendaten auf einmal übergeben kannst. Um eine einfache Implementierung sowie eine robuste Spiegelung zu ermöglichen, bietet der Endpunkt die folgenden Features:

Insert or Update
Du kannst für jeden Datensatz optional eine Personen-ID übergeben, deren bestehende Daten dann aktualisiert werden anstatt dass eine neue Person angelegt wird.
Bring your own IDs
Mit dem Schlüssel external_id kannst du deine eigenen, bestehenden IDs zu campflow mitbringen. Diese müssen einzigartig für jede Person sein (siehe Punkt “Insert or Update”). Du kannst deine IDs dann auch bei anderen Endpunkten anstatt der von campflow generierten IDs verwenden.
Löschen der Weggelassenen
Wenn die delete_omitted Flag gesetzt ist löscht campflow alle Personen, die nicht in den aktuell übermittelten Daten enthalten sind.

Endpunkt

PUT https://api.campflow.de/lists/{list_id}/persons

Request Payload

Key	Typ	Beschreibung
delete_omitted	boolean, optional	Falls true werden alle Personen gelöscht, die nicht in data erwähnt werden.
data	array, Pflichtfeld	Jedes Objekt im Array entspricht einer zu erstellenden bzw. zu aktualisierenden Person. Enthält als Schlüssel Identifier von Feldern.

Enthält ein Personen-Objekt einen Schlüssel id mit der ID einer existierenden Person, so werden die restlichen Daten in dieser aktualisiert anstatt eine neue Person zu erstellen.

Alternativ kann ein Schlüssel external_id verwendet werden, um eine eigene, innerhalb der Liste einzigartige ID festzulegen. Existiert bereits eine Person mit der gegebenen external_id bereits ist das Verhalten analog zur id.

Unbedachter Umgang mit der delete_omitted-Flag kann dazu führen, dass versehentlich alle Mitglieder unwiderruflich gelöscht werden. Nutze diese nur, wenn du weißt was du tust.

{
  "delete_omitted": true,
  "data": [
    {
      "name": {
        "first_name": "Anna",
        "last_name": "Muster"
      },
      "email": "anna@campflow.de"
    },
    {
      "id": "per_3xB563caEa6CE4RuDKbv",
      "name": {
        "first_name": "Benni",
        "last_name": "Muster"
      },
      "email": "benni@campflow.de"
    }
  ]
}

Response Body (Beispiel)

Der Response Body ist identisch mit dem Endpunkt Personen abrufen