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