> ## 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` без контекста существующей переписки.

## Доступ

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

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

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

## Параметры

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

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

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

**recipient\_ids** `integer[]` *required*

Массив ID получателей. В форме повторяйте параметр `recipient_ids[]` для каждого ID.

**title** `string` *required*

Заголовок личной переписки.

**message** `string` *required*

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

**attachment\_key** `string`

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

**conversation\_open** `boolean`

При `0` новые ответы в переписке запрещены; при `1` переписка открыта для ответов.

**open\_invite** `boolean`

При `1` любой участник переписки может приглашать новых пользователей.

## Ответ

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

**success** `true`

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

**conversation** `Conversation`

Сведения о переписке с учётом текущего участника.

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

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

```json 200 · условный пример theme={null}
{
  "success": true,
  "conversation": {
    "conversation_id": 123,
    "title": "Пример переписки"
  }
}
```

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


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