Endpoints / deleteLead

deleteLead

Lead soft-deleten

Setzt deleted=1, deletedBy, deletedTime. reason ist Pflicht. Wiederherstellbar via restoreLead.

HTTP Request

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

Request Parameters

Parameter Pflicht Typ Beispiel / Default
leadId required integer
reason

Begründung für die Löschung

 required string

Response Parameters

Soft-Delete — über restoreLead rückgängig zu machen. Fehler: HTTP 400 Provide a valid leadId., HTTP 422 Reason required for delete.

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/deleteLead
Payload
{
    "leadId": 12345,
    "reason": "Duplikat von einem anderen Lead"
}
Response
{
    "status": true,
    "msg": "Success",
    "result": null
}