Datenmodell

Gespräche

Leichtgewichtiges Kommunikations-Log: ein einzelner Anruf / eine SMS / ein Video- oder Präsenztermin. Beim Erfassen aktualisiert der bump_last_contacted-Hook automatisch das last_contacted_at am übergeordneten Kontakt.

Modellname: conversation
Endpunkte: 5
Max. Seitengröße: 200

Felder

Validierungsregeln pro Feld. Werte, die diese Bedingungen verletzen, werden mit 400 abgewiesen, bevor sie die Datenbank erreichen.

FeldTypRegeln
channelenum
enumcall | sms | whatsapp | email | in_person | video | voice | letter | other
contentstring
max. Länge8000
summarystring
max. Länge400
parent_idstring
max. Länge64ref →contactowned
sentimentenum
enumpositive | neutral | negative
occurred_atstring
max. Länge32
duration_minutesnumber-

Mutabilität

Welche Felder darfst du senden, und wann? Felder ohne Markierung werden vom Server vergeben - das Senden ist kein Fehler, sie werden stillschweigend ignoriert.

Anlegbar - im POST-Body lesbar.Änderbar - im PATCH-Body lesbar.Server-verwaltet - vom Body ignoriert.
FeldAnlegbarÄnderbar
channel
content
summary
parent_id
sentiment
occurred_at
duration_minutes

Felder mit Anlegbar, aber ohne Änderbar, sind nach dem Erstellen unveränderlich. Server-verwaltete Felder umfassen id, Zeitstempel, Eigentümerschaft und Status.

Filter & Sortierung

Auf Listen-Endpunkten kombinierbar. Wiederholte Filter-Keys werden zu IN-Bedingungen, ein - vor einem Sort-Key kehrt die Richtung um. Beispiel: ?status=open&status=blocked&sort=-created_at.

Filter-Keys

parent_iddata__parent_id
channeldata__channel
sentimentdata__sentiment
statusstatus
is_archivedis_archived
owned_byowned_by

Sortier-Keys

created_atcreated_at
occurred_atdata__occurred_at

Standard: occurred_at

Endpunkte

Jeder Endpunkt unten zeigt seine HTTP-Methode, den Pfad und den dafür benötigten PAT-Scope. Code-Beispiele decken curl, JavaScript, TypeScript, Python, Rust, Java und WebSocket ab.

GET/xapi2/data/conversationconversation:list

Objekte auflisten

Liefert eine paginierte Liste sichtbarer Objekte. Standard-Seitengröße 20; mit ?limit= änderbar (typabhängig begrenzt). ?after=<id> für Keyset-Paginierung bei nach created_at sortierten Listen, ?offset= für Offset-Paginierung.

curl -H "Authorization: Bearer pat_…" \
"https://friendship-tracker.com/xapi2/data/conversation?limit=20"
GET/xapi2/data/conversation/{id}conversation:read

Einzelnes Objekt lesen

Liefert das Objekt anhand der ID. 404, falls es nicht existiert oder du keinen Lese-Zugriff hast (beide Fälle sind bewusst zusammengelegt).

curl -H "Authorization: Bearer pat_…" \
https://friendship-tracker.com/xapi2/data/conversation/OBJECT_ID
POST/xapi2/data/conversationconversation:create

Erstellen

Erstellt ein neues Objekt. Der Body ist ein flaches JSON-Dict mit Feldwerten. Server-seitige Felder (id, Zeitstempel, Ownership) werden automatisch gefüllt; nur die unten als anlegbar gelisteten Felder werden aus dem Body übernommen.

curl -H "Authorization: Bearer pat_…" \
-H "Content-Type: application/json" \
-X POST https://friendship-tracker.com/xapi2/data/conversation \
-d '{"name": "…"}'
PATCH/xapi2/data/conversation/{id}conversation:update

Aktualisieren

Teilweise Aktualisierung. Nur Felder im Body werden verändert; alles andere bleibt erhalten. Gleiche Erlaubnisliste wie bei Create, abzüglich der nach dem Anlegen unveränderlichen Felder.

curl -H "Authorization: Bearer pat_…" \
-H "Content-Type: application/json" \
-X PATCH https://friendship-tracker.com/xapi2/data/conversation/OBJECT_ID \
-d '{"name": "…"}'
DELETE/xapi2/data/conversation/{id}conversation:delete

Löschen

Entfernt das Objekt. Es verschwindet sofort aus allen Standard-Listen und wird von read / list nicht mehr zurückgegeben.

curl -H "Authorization: Bearer pat_…" \
-X DELETE https://friendship-tracker.com/xapi2/data/conversation/OBJECT_ID

In der CLI

Dieselben Endpunkte sind auch über die Friendship Tracker CLI verfügbar. Für Skripte, CI und Bulk-Imports ist sie meist die schnellere Wahl.

friendshipcli conversation list --limit 5
friendshipcli conversation get <id>
friendshipcli conversation create --parent-id "Hello"
friendshipcli conversation upsert --unique parent_id --csv items.csv
friendshipcli conversation schema # Felder & Limits

Volle Befehlsreferenz, Profile, CSV-Import, Auto-Retry, NDJSON-Streaming → /docs/cli