> ## 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.

# Ответить в переписке

> Добавляет сообщение в существующую личную переписку.

Добавляет сообщение в существующую личную переписку.

Для файлов используйте `attachment_key` типа `conversation_message` с `context[conversation_id]`, равным ID этой переписки.

## Доступ

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

Требуемые scopes: `conversation:write`. Все перечисленные разрешения нужны одновременно.

Нужен контекст зарегистрированного пользователя. Для Super key укажите `XF-Api-User`; доступ к объектам и действиям проверяется отдельно от scopes.

## Параметры

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

Секретный API-ключ. В примерах ключ берётся из серверной переменной `$FORUM_API_KEY`.

Тело запроса: `application/x-www-form-urlencoded`. Вложенные значения передавайте в форме с квадратными скобками в имени поля.

**conversation\_id** `integer` *required*

ID личной переписки, в которую добавляется сообщение.

**message** `string` *required*

Текст сообщения. Поддерживаемая разметка и ограничения определяются настройками XenForo.

**attachment\_key** `string`

Секретный ключ заранее загруженных вложений. Он должен соответствовать типу и контексту создаваемого или изменяемого сообщения.

## Ответ

HTTP `200`, JSON. [Схемы объектов и условные поля](/guard-forum/models).

**success** `true`

Результат выполнения операции.

**message** `ConversationMessage`

Объект сообщения личной переписки.

Ошибки возвращаются в общей структуре `errors`. Обрабатывайте поле `code`; текст `message` может меняться или переводиться. [Формат ошибок](/guard-forum/requests-and-errors).

```bash cURL theme={null}
curl --request POST 'https://forum.arzguard.com/api/conversation-messages/' \
  --header "XF-Api-Key: $FORUM_API_KEY" \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'conversation_id=123' \
  --data-urlencode 'message=Пример сообщения'
```

```json 200 · условный пример theme={null}
{
  "success": true,
  "message": {
    "message_id": 123,
    "conversation_id": 123,
    "message": "Пример сообщения"
  }
}
```

Примеры сокращены и содержат только условные значения. Состав полей объектов зависит от прав, контекста и установленных дополнений.


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