notices

POST /v1/alerts/read

The customer has seen these alerts.

Alle notices-eindpunten

Authenticatie

Stuur een API-sleutel mee als bearer token. Dit eindpunt vermeldt geen specifieke toestemming in de specificatie, dus geef uw sleutel de minimale rechten die nodig zijn en controleer het antwoord in plaats van zomaar wat aan te nemen.

Waar je organisatie-id komt te staan

Dit eindpunt accepteert org_id als queryparameter. Laat deze achterwege en de aanroep destilleert je gehele tenant-substructie; stuur deze mee om de aanroep te beperken tot één organisatie.

Uw organisatie-id staat op het scherm met API-sleutels in uw dashboard, naast de sleutel zelf. Dit is in elke aanroep die u doet dezelfde id.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.

curl -X POST https://api.zinndigital.com/v1/alerts/read \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "alert_keys": <string[]> }'

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console

Details

Clears the badge for these keys, for **this user only** — a colleague clearing the bell must not clear it for the rest of the team. ⚠️ **Read is not dismissed and not resolved.** An expired card that has been read is still expired, still listed and still red. Conflating the three would let a customer make a real problem *look* solved by opening a dropdown. Idempotent: the panel marks on open, and customers open it repeatedly.

Parameters

NaamTypeVerplichtWat dit is
org_id (query)stringNee

Aanvraaglichaam

NaamTypeVerplichtWat dit is
alert_keysstring[]JaThe keys the panel actually rendered. ⛔ A list, never a "mark everything" boolean: an alert that arrived between the render and the click must NOT be marked seen, and a server-s…

Fouten die dit eindpunt kan retourneren

401 · 422 · 429