setWatchState
Watch-Status (join/leave/markRead) idempotent setzen
Idempotent: watching=true fügt User als Watcher hinzu, false entfernt. read=true setzt LastReadActivity auf jetzt.
HTTP Request
POST
https://dev.vitabyte.ch/v1/sales/setWatchState
Auth
basicAuth
apiKey
Request Parameters
Konsolidiert die Aktionen join, leave und markRead in einen idempotenten Aufruf: watching: true fügt den User hinzu (mit read als Gelesen-Flag), watching: false entfernt ihn. read wirkt nur zusammen mit watching: true.
| Parameter | Pflicht | Typ | Beispiel / Default |
|---|---|---|---|
leadId
|
required | integer | |
userId
|
required | integer | |
watching
true=join, false=leave |
optional | boolean | |
read
true=als gelesen markieren |
optional | boolean |
Response Parameters
Wird ein Watcher hinzugefügt oder entfernt, entsteht ein History-Eintrag vom Typ J. Fehler: HTTP 400 Provide valid leadId and userId.
| 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/setWatchState
Payload
{
"leadId": 12345,
"userId": 12,
"watching": true,
"read": false
}Response
{
"status": true,
"msg": "Success",
"result": null
}