notices

POST `/v1/alerts/read`

The customer has seen these alerts.

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

Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.

Идентификатор вашей организации

Этот эндпоинт принимает 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 в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему 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