Technische Referenz (Swagger):
API-Übersicht: https://api.memberspot.de/api
Mehrere Attribute per E-Mail: set-custom-user-properties
Mehrere Attribute per uid: set-custom-user-properties-by-uid
Einzelnes Attribut per E-Mail: set-custom-property
Einzelnes Attribut per uid: set-custom-property-by-uid
Attribut-IDs auflisten: custom-user-properties/list
Wichtig zu wissen: Die API setzt den Wert eines Attributs immer für ein einzelnes Mitglied. Es gibt keine Funktion, um ein Attribut auf einen Schlag für eine ganze Gruppe von Mitgliedern zu setzen – jedes Mitglied wird einzeln angesprochen (z. B. in einer Schleife in deinem Automatisierungstool).
1. Voraussetzung: API-Key
Kurz erklärt: So setzt du ein Attribut
Wenn du noch nie mit einer API gearbeitet hast, gehe bitte Schritt für Schritt folgendermaßen vor:
Erstelle einen API-Key.
Ermittle die ID des gewünschten Attributs.
Öffne in Swagger den passenden Endpoint.
Klicke oben rechts auf „Authorize“ und gib deinen API-Key ein.
Klicke auf „Try it out“.
Trage deine Daten in das vorgegebene Feld ein.
Klicke auf „Execute“.
Prüfe die Antwort der API.
Für jeden Request brauchst du einen API-Key. Du erstellst ihn unter:
Einstellungen → API Keys (bzw. direkt über /settings/apikeys)
Der Key wird im Header jeder Anfrage mitgeschickt. Der Header heißt:
X-API-KEY: dein-api-key
Ohne gültigen Key bekommst du einen Fehler zurück (siehe Fehlercodes weiter unten).
Rate Limit: Die API erlaubt maximal 4 Anfragen pro Sekunde. Bei Überschreitung kann die API mit Fehlercode 429 Too Many Requests antworten.
2. Die passende Attribut-ID herausfinden
Jedes Attribut hat eine eigene ID (nicht identisch mit dem sichtbaren Namen). Um herauszufinden, welche ID zu welchem Attribut gehört, nutzt du:
GET /v1/custom-user-properties/list
Antwort (Beispiel):
json
[ { "id": "abc123", "schoolId": "deineSchoolId", "type": "text", "name": "Kundentyp" } ]Die id aus dieser Liste ist der Wert, den du bei den folgenden Endpoints im Feld id bzw. key einträgst.
3. Ein Attribut setzen – die vier Endpoints
Es gibt vier Varianten, je nachdem, wie du das Mitglied identifizierst (E-Mail-Adresse oder interne Mitglieds-ID "uid") und wie viele Attribute du gleichzeitig setzen willst.
Mini-Entscheidungshilfe
Welchen Endpoint brauche ich?
Ich kenne die E-Mail-Adresse des Mitglieds:
→ Verwende einen Endpoint per E-Mail.
Ich kenne die interne UID des Mitglieds:
→ Verwende einen Endpoint per UID.
Ich möchte mehrere Attribute gleichzeitig setzen:
→ Verwende set-custom-user-properties.
Ich möchte nur ein einzelnes Attribut setzen:
→ Verwende set-custom-property.
Endpoint | Mitglied identifiziert über | Anzahl Attribute |
| mehrere gleichzeitig | |
| uid | mehrere gleichzeitig |
| genau eins | |
| uid | genau eins |
3.1 Mehrere Attribute gleichzeitig setzen (per E-Mail)
POST /v1/users/set-custom-user-properties
json
{ "email": "user@example.com", "properties": [ { "id": "abc123", "value": "Premium" }, { "id": "def456", "value": "2026-01-01" } ] }Beispiel sinngemäß erklärt
Diese Werte musst du anpassen:
user@example.com→ E-Mail-Adresse des Mitgliedsabc123→ ID des gewünschten AttributsPremium→ Wert, den du für das Attribut setzen möchtest
Die übrige Struktur lässt du unverändert.
3.2 Mehrere Attribute gleichzeitig setzen (per uid)
POST /v1/users/set-custom-user-properties-by-uid
json
{ "uid": "uid-abc123", "properties": [ { "id": "abc123", "value": "Premium" } ] }3.3 Nur ein einzelnes Attribut setzen (per E-Mail)
POST /v1/users/set-custom-property
json
{ "email": "user@example.com", "key": "abc123", "value": "Premium" }3.4 Nur ein einzelnes Attribut setzen (per uid)
POST /v1/users/set-custom-property-by-uid
json
{ "uid": "uid-abc123", "key": "abc123", "value": "Premium" }4. Antwort der API
Woran erkenne ich, dass es funktioniert hat?
Wenn die Anfrage erfolgreich war, erhältst du unter „Response“ das aktualisierte Mitgliedsprofil.
Prüfe dort, ob dein Attribut unter customUserProperties mit dem gewünschten Wert erscheint.
Bei erfolgreicher Anfrage bekommst du das komplette, aktualisierte Mitgliedsprofil zurück, inklusive aller Attribute:
json
{ "uid": "uid-abc123", "email": "user@example.com", "customUserProperties": { "abc123": "Premium", "def456": "2026-01-01" }, ... }
5. Wichtige Sonderfälle
Leerer Wert: Wenn du
valueweglässt odernullschickst, wird das Attribut bei den Endpointsset-custom-propertyundset-custom-property-by-uidauf einen leeren Text gesetzt (nicht gelöscht).Bei den Bulk-Endpoints
set-custom-user-propertiesundset-custom-user-properties-by-uidmussvalueals String angegeben werden.Mitglied nicht gefunden: Existiert die E-Mail oder uid nicht, kommt ein Fehler zurück – es wird nichts angelegt.
Attribut-ID nicht gefunden/ungültiger Wert: Auch hier antwortet die API mit einem Fehler, statt das Attribut einfach zu ignorieren.
6. Fehlercodes im Überblick
Code | Bedeutung |
| Angaben fehlen oder sind ungültig (z. B. fehlender API-Key, unbekanntes Mitglied/Attribut oder ungültiger Wert) |
| API-Key ist ungültig |
| API-Zugriff ist im gebuchten Tarif nicht enthalten |
| Zu viele Anfragen - Rate Limit überschritten |
Häufige Fragen
Kann ich damit ein Attribut für eine ganze Mitgliedergruppe auf einmal ändern?
Nein. Die API arbeitet immer pro einzelnem Mitglied. Für mehrere Mitglieder musst du den Request in deinem Automatisierungstool für jedes Mitglied einzeln wiederholen (z. B. in einer Schleife).
Wo finde ich die vollständige, technische Referenz? Unter https://api.memberspot.de/api – dort lassen sich alle Endpoints auch direkt live testen ("Try it out").
So verwendest du den Endpoint in Swagger
Öffne den oben verlinkten Endpoint.
Klicke oben rechts auf „Authorize“.
Gib deinen API-Key ein.
Öffne anschließend den Bereich „Try it out“.
Trage die gewünschten Werte in das Eingabefeld ein.
Klicke auf „Execute“.
Die Anfrage wird nun direkt an die Memberspot-API gesendet. Unter „Response“ siehst du, ob die Anfrage erfolgreich war oder ein Fehler zurückgegeben wurde.