Endpoints / createRecall

createRecall

Recall anlegen

Legt eine Recall-Erinnerung an (Brief, SMS oder Mail). Der Recall startet im Status pending.

HTTP Request

POST https://dev.vitabyte.ch/v1/recall/createRecall

Auth basicAuth apiKey

Request Parameters

⚠ Die Felder recipient und cc (Empfänger-Steuerung PAT / HA / ZU bei recallType: mail) gehören zu einem noch nicht ausgerollten Branch und bleiben derzeit ohne Wirkung.

Parameter	Pflicht	Typ	Beispiel / Default
`title` Darf nicht leer sein.	required	string	Jahreskontrolle
`patid` Muss grösser als 0 sein.	required	integer	789
`nextRecall` Datum mit Uhrzeit; wird intern in Datum und Zeit zerlegt. Nicht parsebare Werte werden abgewiesen.	required	string	2027-05-18 09:00:00
`recallType` Alles andere ist ein Fehler.	required	string enum: brief \| sms \| mail	mail
`recallText` Inhalt der Erinnerung.	optional	string
`internalComment` Interne Notiz.	optional	string
`active` Alles ausser exakt 1 wird zu 0.	optional	integer enum: 0 \| 1	default: `0` 1

Response Parameters

Fehler kommen als {status:false, msg} mit HTTP 200: Please provide a recall title., Please provide a valid patid., Please provide a valid recall date., Please provide a valid recallType (brief/sms/mail).

Field	Typ	Beschreibung
`recallId`	integer	ID des neuen Recalls

Demo

Referenz und Beispiele stammen aus der internen API-Collection — die OpenAPI-Spec deckt diesen Endpoint noch nicht ab.

POST https://dev.vitabyte.ch/v1/recall/createRecall

Payload

{
    "title": "Jahreskontrolle",
    "recallText": "Es ist Zeit für Ihre jährliche Kontrolle.",
    "nextRecall": "2027-05-18 09:00:00",
    "patid": 789,
    "recallType": "mail",
    "active": 1,
    "internalComment": "via API angelegt"
}

Response

{
    "status": true,
    "msg": "Recall created",
    "result": {
        "recallId": 42
    }
}