Data model

Email templates

Reusable outbound mail template: subject + plain-markdown body, optionally bound to a stage transition for auto-send.

Model name: email_template

Endpoints: 5

Max page size: 100

Fields

Per-field validation rules. Values that violate any constraint are rejected with 400 before they reach the database.

Field	Type	Constraints
body	`string`
name	`string`	max length`200`
active	`bool`	-
subject	`string`	max length`400`
category	`enum`	enum`acknowledge \| screening_invite \| interview_invite \| rejection \| offer \| talent_pool \| other`
language	`string`	max length`16`
auto_send	`bool`	-
stage_trigger	`enum`	enum `\| new \| review \| screening \| interview \| offer \| hired \| rejected \| talent_pool`
variables_doc	`string`	max length`2000`

Mutability

Which fields can you send, and when? Anything without a marker is server-managed - sending it isn't an error, it's silently ignored.

Create-only - read from POST body.Patchable - read from PATCH body.Server-managed - ignored on the body.

Field	Type	Create	Patch
body	string
name	string
active	bool
subject	string
category	enum
language	string
auto_send	bool
stage_trigger	enum
variables_doc	string

Fields marked create-only but not patchable are immutable after creation. Server-managed fields include id, timestamps, ownership, and status.

Filtering & sorting

Combinable on list endpoints. Repeating a filter key produces an IN clause; prefixing a sort key with - reverses direction. Example: ?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

Sort keys

created_atcreated_at

namedata__name

Default: name

Endpoints

Each endpoint below lists its HTTP method, path, and the PAT scope it needs. Code samples cover curl, JavaScript, TypeScript, Python, Rust, Java, and WebSocket.

GET/xapi2/data/email_templateemail_template:list

List objects

Returns a paginated list of objects you can read. Default page size is 20; pass ?limit= to change (capped per type). Use ?after=<id> for keyset pagination on created_at-sorted lists, or ?offset= for offset paging.

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

Read one

Returns the object by id. 404 if it does not exist or you cannot read it (the two cases are intentionally conflated).

curl -H "Authorization: Bearer pat_…" \
     https://www.ki-bewerber-management.de/xapi2/data/email_template/OBJECT_ID

POST/xapi2/data/email_templateemail_template:create

Create

Creates a new object. Body is a flat JSON dict of field values. Server-side fields (id, timestamps, ownership) are filled automatically; only fields listed below as creatable are read from the body.

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

Update

Partial update. Only fields included in the body are touched; everything else is preserved. Same allow-list as create, minus the fields that are immutable post-create.

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

Delete

Removes the object. It vanishes from every default list immediately and stops being returned by read / list.

curl -H "Authorization: Bearer pat_…" \
     -X DELETE https://www.ki-bewerber-management.de/xapi2/data/email_template/OBJECT_ID

Use in CLI

The same endpoints are also exposed via the KI BMS CLI. For scripts, CI, and bulk imports it's usually the faster path.

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   # fields & limits

Full command reference, profiles, CSV import, auto-retry, NDJSON streaming → /docs/cli