Datenmodell

Nachrichten

Ausgehende Kommunikation an Bewerber:innen (E-Mail oder freie Notiz). Trägt Betreff, Inhalt, Status (entwurf / gesendet / fehlgeschlagen), gelesen-Zeitpunkt, Vorlagen-Referenz.

Modellname: message

Endpunkte: 5

Max. Seitengröße: 200

Felder

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

Feld	Typ	Regeln
body	`string`
error	`string`	max. Länge`600`
status	`enum`	enum`draft \| queued \| sent \| delivered \| failed \| bounced`
channel	`enum`	enum`email \| note`
read_at	`string`	max. Länge`32`
sent_at	`string`	max. Länge`32`
subject	`string`	max. Länge`400`
direction	`enum`	enum`outbound \| inbound`
thread_id	`string`	max. Länge`200`
to_address	`string`	max. Länge`320`
template_id	`string`	max. Länge`64`ref →`email_template`
candidate_id	`string`	max. Länge`64`
cc_addresses	`list`	-
delivered_at	`string`	max. Länge`32`
from_address	`string`	max. Länge`320`
application_id	`string`	max. Länge`64`

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.

Feld	Typ	Anlegbar	Änderbar
body	string
error	string
status	enum
channel	enum
read_at	string
sent_at	string
subject	string
direction	enum
thread_id	string
to_address	string
template_id	string
candidate_id	string
cc_addresses	list
delivered_at	string
from_address	string
application_id	string

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

candidate_iddata__candidate_id

application_iddata__application_id

channeldata__channel

statusdata__status

template_iddata__template_id

statusstatus

is_archived

owned_byowned_by

created_bycreated_by

Sortier-Keys

created_atcreated_at

sent_atdata__sent_at

Standard: -data__sent_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/messagemessage: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://www.ki-bewerber-management.de/xapi2/data/message?limit=20"

GET/xapi2/data/message/{id}message: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://www.ki-bewerber-management.de/xapi2/data/message/OBJECT_ID

POST/xapi2/data/messagemessage: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://www.ki-bewerber-management.de/xapi2/data/message \
     -d '{"name": "…"}'

PATCH/xapi2/data/message/{id}message: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://www.ki-bewerber-management.de/xapi2/data/message/OBJECT_ID \
     -d '{"name": "…"}'

DELETE/xapi2/data/message/{id}message: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://www.ki-bewerber-management.de/xapi2/data/message/OBJECT_ID

In der CLI

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

atscli message list --limit 5
atscli message get <id>
atscli message create --candidate-id "Hello"
atscli message upsert --unique candidate_id --csv items.csv
atscli message schema   # Felder & Limits

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