> ## Documentation Index
> Fetch the complete documentation index at: https://docs.arzguard.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Удалить сообщение

> Удаляет сообщение: по умолчанию мягко, с отдельным флагом — окончательно.

Удаляет сообщение: по умолчанию мягко, с отдельным флагом — окончательно.

## Доступ

В каждом запросе обязателен заголовок `XF-Api-Key`. Примеры используют серверную переменную `$FORUM_API_KEY`; [тип ключа и контекст пользователя](/guard-forum/authentication) определяют доступ к данным.

**XF-Api-Key** `string` *required*

Ключ API. Храните его на сервере интеграции; в примере используется переменная окружения.

Обязательные scopes: `thread:write`.

При `hard_delete=1` дополнительно требуется `thread:delete_hard`.

## Особенности

Без `hard_delete=1` используется мягкое удаление. Окончательное удаление требует одновременно обычного scope записи, дополнительного scope `delete_hard` и соответствующих прав пользователя.

## Параметры

**id** `integer` *required*

ID сообщения. Значение `123` в примере условное.

**hard\_delete** `boolean`

При `1` запрашивает окончательное удаление. По умолчанию выполняется мягкое удаление; дополнительные scopes указаны выше.

**reason** `string`

Причина удаления для журнала действия.

**author\_alert** `boolean`

При `1` отправляет автору уведомление о действии, если отправка разрешена для этого содержимого.

**author\_alert\_reason** `string`

Пояснение к уведомлению автору; используется вместе с `author_alert`.

Тело запроса: `application/x-www-form-urlencoded`. Данные передаются в UTF-8.

## Успешный ответ

HTTP `200`. Пример ниже сокращён и содержит только условные данные. Полные объекты и условия видимости полей описаны в [схемах данных](/guard-forum/models).

| Поле | Тип | Описание |
| - | - | - |
| `success` | `true` | `true`, если действие выполнено успешно. |

## Ошибки

Стандартный ответ содержит массив `errors` с `code`, `message` и `params`. Проверяйте HTTP-статус и машинный код; [формат и обработка ошибок](/guard-forum/requests-and-errors) общие для API.

```bash cURL theme={null}
curl --request DELETE \
  --header "XF-Api-Key: $FORUM_API_KEY" \
  --header 'Accept: application/json' \
  'https://forum.arzguard.com/api/posts/123/'
```

```json Сокращённый условный ответ theme={null}
{
  "success": true
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.