Datenmodell

E-Mail-Vorlagen

Wiederverwendbare Vorlage für ausgehende Mails: Betreff + Body in Klar-Markdown, optional an einen Stage-Übergang gebunden für Auto-Versand.

Modellname: email_template

Endpunkte: 5

Max. Seitengröße: 100

Felder

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

Feld	Typ	Regeln
body	`string`
name	`string`	max. Länge`200`
active	`bool`	-
subject	`string`	max. Länge`400`
category	`enum`	enum`acknowledge \| screening_invite \| interview_invite \| rejection \| offer \| talent_pool \| other`
language	`string`	max. Länge`16`
auto_send	`bool`	-
stage_trigger	`enum`	enum `\| new \| review \| screening \| interview \| offer \| hired \| rejected \| talent_pool`
variables_doc	`string`	max. Länge`2000`

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
name	string
active	bool
subject	string
category	enum
language	string
auto_send	bool
stage_trigger	enum
variables_doc	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

namedata__name

categorydata__category

stage_triggerdata__stage_trigger

activedata__active

statusstatus

is_archivedis_archived

owned_byowned_by

created_bycreated_by

Sortier-Keys

created_atcreated_at

namedata__name

Standard: name

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/email_templateemail_template: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/email_template?limit=20"

GET/xapi2/data/email_template/{id}email_template: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/email_template/OBJECT_ID

POST/xapi2/data/email_templateemail_template: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/email_template \
     -d '{"name": "…"}'

PATCH/xapi2/data/email_template/{id}email_template: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/email_template/OBJECT_ID \
     -d '{"name": "…"}'

DELETE/xapi2/data/email_template/{id}email_template: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/email_template/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 email_template list --limit 5
atscli email_template get <id>
atscli email_template create --name "Hello"
atscli email_template upsert --unique name --csv items.csv
atscli email_template schema   # Felder & Limits

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