Data model

Messages

Outbound communication to a candidate (email or free note). Carries subject, body, status (draft / sent / failed), read_at, optional template reference.

Model name: message

Endpoints: 5

Max page size: 200

Fields

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

Field	Type	Constraints
body	`string`
error	`string`	max length`600`
status	`enum`	enum`draft \| queued \| sent \| delivered \| failed \| bounced`
channel	`enum`	enum`email \| note`
read_at	`string`	max length`32`
sent_at	`string`	max length`32`
subject	`string`	max length`400`
direction	`enum`	enum`outbound \| inbound`
thread_id	`string`	max length`200`
to_address	`string`	max length`320`
template_id	`string`	max length`64`ref →`email_template`
candidate_id	`string`	max length`64`
cc_addresses	`list`	-
delivered_at	`string`	max length`32`
from_address	`string`	max length`320`
application_id	`string`	max length`64`

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
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

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

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

Sort keys

created_atcreated_at

sent_atdata__sent_at

Default: -data__sent_at

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/messagemessage: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/message?limit=20"

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

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

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

DELETE/xapi2/data/message/{id}message: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/message/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 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   # fields & limits

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