notices

POST `/v1/alerts/read`

The customer has seen these alerts.

Аутентификација

Пошаљите API кључ као bearer токен. Ова крајња тачка не наводи конкретну дозволу у спецификацији, па свом кључу доделите најмања неопходна овлашћења и проверите одговор уместо да претпостављате.

Где се уноси ID ваше организације

Ова крајња тачка прихвата org_id као параметар упита. Изоставите га и позив ће обухватити цело подстабло вашег закупа; пошаљите га да бисте сузили позив на једну организацију.

Идентификатор ваше организације се налази на екрану са API кључевима на вашој контролној табли, поред самог кључа. То је исти идентификатор у сваком позиву који упутите.

Испробајте

Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.

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

Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли

Детаљи

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.

Параметри

Назив	Тип	Обавезно	Шта је ово
`org_id (query)`	`string`	Не	—

Тело захтева

Назив	Тип	Обавезно	Шта је ово
`alert_keys`	`string[]`	Да	The 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…

Грешке које ова крајња тачка може вратити

401 · 422 · 429

POST /v1/alerts/read