Mit einzelnen Personen arbeiten

Mit den folgenden Endpunkten kannst du einzelne Personen (Mitglieder, Teilnehmende, Kontakte) erstellen oder anhand ihrer Felder bearbeiten.

• Person erstellen
• Person aktualisieren
• Person abrufen
• Person löschen

Bring your own IDs

Campflow generiert automatisch für jede Person eine eindeutige id. Diese beginnt immer mit per_, gefolgt von einer zufälligen Zeichenkette. Allerdings werden Teilnehmende per API oftmals aus einem externen System gespiegelt, in dem schon IDs vorhanden sind.

Mit dem Feld external_id kannst du deine eigenen, bestehenden IDs zu campflow mitbringen. Diese müssen einzigartig für jede Person der Liste sein. Du kannst dann deine eigenen IDs bei allen folgenden Endpunkten anstatt der von campflow generierten IDs verwenden.

Person erstellen

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

Fügt der Liste {list_id} eine neue Person hinzu.

Request Payload

Status Codes / Troubleshooting

Response (Beispiel)

{
  "data": {
    "name": {
      "first_name": "Anna",
      "last_name": "Muster"
    },
    "email": "anna@campflow.de",
    "...": "..."
  }
}

Die Response enthält alle verfügbaren Felder der Person.

Person aktualisieren

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

Aktualisiert die Felder der Person {person_id}. Die Person muss in der Liste {list_id} enthalten sein.

Alternativ zur campflow-generierten ID der Person kann auch eine eigene als {person_id} verwendet werden (siehe bring your own ID).

Request Payload

Status Codes / Troubleshooting

Response (Beispiel)

{
  "data": {
    "name": {
      "first_name": "Anna",
      "last_name": "Muster"
    },
    "email": "anna@campflow.de",
    "...": "..."
  }
}

Die Response enthält alle verfügbaren Felder der Person.

Person abrufen

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

Gibt die Felder der Person {person_id} zurück. Die Person muss in der Liste {list_id} enthalten sein.

Alternativ zur campflow-generierten ID der Person kann auch eine eigene als {person_id} verwendet werden (siehe bring your own ID).

Status Codes / Troubleshooting

Response (Beispiel)

{
  "data": {
    "name": {
      "first_name": "Anna",
      "last_name": "Muster"
    },
    "email": "anna@campflow.de",
    "...": "..."
  }
}

Die Response enthält alle verfügbaren Felder der Person.

Person löschen

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

Löscht die Felder der Person {person_id} unwiderruflich. Die Person muss in der Liste {list_id} enthalten sein.

Alternativ zur campflow-generierten ID der Person kann auch eine eigene als {person_id} verwendet werden (siehe bring your own ID).

Status Codes / Troubleshooting

Response (Beispiel)

leer