Eigene Felder anlegen

Für jede Liste können eigene Felder angelegt werden. Dies ist insbesondere praktisch, um zu Beginn einer API-Integration das benötigte Schema anzulegen.

Es gibt derzeit keine Möglichkeit, die eigenen Felder über die API wieder zu löschen.

Eigene Felder abrufen

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

Ruft alle existierenden eigenen Spalten der Liste ab.

Status Codes / Troubleshooting

Status Code	Hinweis
200 OK	Erfolgreich
402 Payment Required	Der Listentyp ist nicht in der Variante des campflow-Abos enthalten
403 Forbidden	Keine Berechtigung für die Liste
404 Not Found	Die Liste wurde nicht gefunden
und weitere

Response (Beispiel)

{
  "data": [
    {
      "id": "col_NzZbo6WvHQTjKNZJvQVt",
      "type": "string",
      "name": "Lieblingsfarbe",
      "external_id": null
    },
    {
      "id": "col_EbaXHsHoAhGFYOjsJ8CO",
      "type": "boolean",
      "name": "Pulli bestellt",
      "external_id": "pullover_ordered"
    },
    {
      "id": "col_3xB563caEa6CE4RuDKbv",
      "type": "string",
      "name": "Pulligröße",
      "external_id": "pullover_size"
    }
  ]
}

Eigene Felder anlegen

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

Fügt der Liste {list_id} mehrere eigene Felder hinzu.

Request Payload

Key	Typ	Beschreibung
`data`	Array	Array von eigenen Feldern, die erstellt werden sollen
`data.*.name`	String	Leserlicher Name des Feldes, maximal 64 Zeichen lang
`data.*.type`	Gültiger Typ	Gibt an, welcher Datentyp in diesem Feld gespeichert wird. Der Typ des Feldes kann im Nachhinein nicht mehr geändert werden.
`data.*.external_id`	String (optional)	Eigener Schlüssel, der beim Schreiben von Personen über die API verwendet werden kann. Es darf in der Liste noch kein Schlüssel mit dieser `external_id` existieren.

{
  "data": [
    {
      "type": "boolean",
      "name": "Pulli bestellt",
      "external_id": "pullover_ordered"
    },
    {
      "type": "string",
      "name": "Pulligröße",
      "external_id": "pullover_size"
    }
  ]
}

Status Codes / Troubleshooting

Status Code	Hinweis
201 Created	Eigene Felder erfolgreich erstellt
402 Payment Required	Der Listentyp ist nicht in der Variante des campflow-Abos enthalten
403 Forbidden	Keine Berechtigung für die Liste
404 Not Found	Die Liste wurde nicht gefunden
422 Unprocessable Entity	Validierungsfehler, prüfe den Response Body für weiterführende Hinweise
und weitere

Response (Beispiel)

{
  "data": [
    {
      "id": "col_EbaXHsHoAhGFYOjsJ8CO",
      "type": "boolean",
      "name": "Pulli bestellt",
      "external_id": "pullover_ordered"
    },
    {
      "id": "col_3xB563caEa6CE4RuDKbv",
      "type": "string",
      "name": "Pulligröße",
      "external_id": "pullover_size"
    }
  ]
}

Alle erstellen Felder werden zurückgegeben.