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

# Изменить сообщение переписки

> Обновляет текст или вложения доступного сообщения.

Обновляет текст или вложения доступного сообщения.

Для новых вложений ключ должен иметь тип `conversation_message` и `context[message_id]`, равный ID изменяемого сообщения. Право на просмотр переписки не означает право редактировать любое её сообщение.

## Доступ

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

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

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

## Параметры

<ParamField header="XF-Api-Key" type="string" required>
  Секретный API-ключ. В примерах ключ берётся из серверной переменной `$FORUM_API_KEY`.
</ParamField>

<ParamField path="id" type="integer" required>
  Идентификатор сообщения.
</ParamField>

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

<ParamField body="message" type="string">
  Текст сообщения. Поддерживаемая разметка и ограничения определяются настройками XenForo.
</ParamField>

<ParamField body="attachment_key" type="string">
  Секретный ключ заранее загруженных вложений. Он должен соответствовать типу и контексту создаваемого или изменяемого сообщения.
</ParamField>

## Ответ

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

<ResponseField name="success" type="true">
  Результат выполнения операции.
</ResponseField>

<ResponseField name="message" type="ConversationMessage">
  Объект сообщения личной переписки.
</ResponseField>

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

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

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

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


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