curl --request POST \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Accept: application/json' \
'https://forum.arzguard.com/api/forums/123/mark-read'
{
"success": true
}
Форумы
Отметить раздел прочитанным
Переносит отметку прочтения раздела до указанного момента.
POST
/
api
/
forums
/
{id}
/
mark-read
curl --request POST \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Accept: application/json' \
'https://forum.arzguard.com/api/forums/123/mark-read'
{
"success": true
}
Переносит отметку прочтения раздела до указанного момента.
Обязательные scopes:
Тело запроса:
Доступ
В каждом запросе обязателен заголовокXF-Api-Key. Примеры используют серверную переменную $FORUM_API_KEY; тип ключа и контекст пользователя определяют доступ к данным.
string
required
Ключ API. Храните его на сервере интеграции; в примере используется переменная окружения.
thread:read.
Требуется контекст зарегистрированного пользователя; гостевой контекст не подходит.
Особенности
Метод не делает содержимое непрочитанным и не переносит отметку назад. Успешный ответ не содержит счётчика непрочитанных сообщений.Параметры
integer
required
ID раздела. Значение
123 в примере условное.integer
Unix timestamp в секундах, до которого отметить содержимое прочитанным. Без значения используется текущее время;
0 и будущая дата также обрабатываются как текущее время.application/x-www-form-urlencoded. Данные передаются в UTF-8.
Успешный ответ
HTTP200. Пример ниже сокращён и содержит только условные данные. Полные объекты и условия видимости полей описаны в схемах данных.
| Поле | Тип | Описание |
|---|---|---|
success | true | true, если действие выполнено успешно. |
Ошибки
Стандартный ответ содержит массивerrors с code, message и params. Проверяйте HTTP-статус и машинный код; формат и обработка ошибок общие для API.
curl --request POST \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Accept: application/json' \
'https://forum.arzguard.com/api/forums/123/mark-read'
{
"success": true
}