Endpoints / deleteLeadHistoryEntry

deleteLeadHistoryEntry

History-Eintrag soft-deleten

Setzt deleted=1 auf tblSalesHistory.id. Wiederherstellbar nur per SQL.

HTTP Request

POST https://dev.vitabyte.ch/v1/sales/deleteLeadHistoryEntry
Auth basicAuth apiKey

Request Parameters

Parameter Pflicht Typ Beispiel / Default
historyId required integer

Response Parameters

Soft-Delete. Mit includeDeleted: true sind solche Einträge in getLeadHistory weiterhin sichtbar (z. B. für Audits). Fehler: HTTP 400 Provide a valid historyId., HTTP 404 wenn der Eintrag nicht existiert.

Field Typ Beschreibung
status boolean true bei Erfolg, false bei Fehler
msg string Kurzbeschreibung des Resultats / der Fehlerursache
result Endpoint-spezifisches Resultat. Typ je nach Endpoint (Object, Array, Skalar oder null).
pagination Nur bei Listen-Endpoints gesetzt

Demo

Beispiel-Response handgepflegt — die OpenAPI-Spec liefert für diesen Endpoint noch kein Response-Example.

POST https://dev.vitabyte.ch/v1/sales/deleteLeadHistoryEntry
Payload
{
    "historyId": 9876
}
Response
{
    "status": true,
    "msg": "Success",
    "result": null
}