Endpoints / modifyRecall

modifyRecall

Recall ändern

Ändert einen bestehenden Recall.

HTTP Request

POST https://dev.vitabyte.ch/v1/recall/modifyRecall
Auth basicAuth apiKey

Request Parameters

Kein PATCH — der Datensatz wird überschrieben. Geprüft wird nur die recallId, danach läuft dieselbe Logik wie bei createRecall. Alle Pflichtfelder (title, patid, nextRecall, recallType) müssen erneut mitgeschickt werden, sonst kommt eine Validierungsmeldung oder das Feld wird leer überschrieben.

Parameter Pflicht Typ Beispiel / Default
recallId

Muss existieren.

required integer
42
title

Wie bei createRecall.

required string
Jahreskontrolle
patid

Wie bei createRecall.

required integer
789
nextRecall

Wie bei createRecall.

required string
2027-06-01 09:00:00
recallType

Wie bei createRecall.

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: Please provide a valid recallId. bzw. There is no recall with the provided recallId. — dazu alle Validierungsfehler von createRecall. Immer HTTP 200.

Field Typ Beschreibung
recallId integer ID des geänderten 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/modifyRecall
Payload
{
    "recallId": 42,
    "title": "Jahreskontrolle (verschoben)",
    "recallText": "Es ist Zeit für Ihre jährliche Kontrolle.",
    "nextRecall": "2027-06-01 09:00:00",
    "patid": 789,
    "recallType": "mail",
    "active": 1,
    "internalComment": "via API verschoben"
}
Response
{
    "status": true,
    "msg": "Recall modified",
    "result": {
        "recallId": 42
    }
}