← Справочник API
БеседыPOST

Mark conversation as unread

Marks a conversation as unread. Pass conversation_id in the JSON body.

https://api.unifyport.ai/v1/accounts/{account_id}/conversations/unread

Заголовки

X-Api-Key
stringобязательно

API-ключ рабочей области. Рабочая область определяется по этому заголовку.

Content-Type
stringобязательно

Используйте application/json при отправке JSON-тела запроса.

Параметры пути

account_id
stringобязательно

Идентификатор для маршрута раздела conversations.

Тело запроса

conversation_id
stringобязательно

Идентификатор целевой беседы.

Тело ответа

ok
boolean

Всегда true при успешном выполнении операции; при ошибках вместо этого возвращается статус не из диапазона 2xx.

Ответы

200
200 OK

Запрос выполнен. См. пример тела ответа.

400
Bad Request

Тело запроса, путь или параметры некорректны.

401
Unauthorized

Заголовок X-Api-Key отсутствует или недействителен.

404
Not Found

Запрошенный ресурс провайдера не найден.

409
Conflict

Запрошенная операция конфликтует с существующим аккаунтом провайдера или ресурсом.

500
Internal Server Error

Сервис столкнулся с неожиданной ошибкой.

501
Not Implemented

Выбранный провайдер не реализует эту операцию.

502
Bad Gateway

Адаптер или вышестоящий провайдер не смог завершить операцию.

Запрос

curl -X POST https://api.unifyport.ai/v1/accounts/{account_id}/conversations/unread \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "conversation_id": "peer_example"
}'

Ответ

{
  "data": {
    "ok": true
  }
}