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

# Создать, изменить, опубликовать или удалить новость

> Выполняет operation=create, update, state или delete.

Выполняет operation=create, update, state или delete. Требуется news:write, управленческие права модератора в CRM, Idempotency-Key и актуальная expected\_version для существующей новости. Создание формирует черновик. Для публикации используйте state=published, для отложенной публикации — state=scheduled и publish\_at. Аудитория серверной новости ограничена согласованными серверами. Публичная аудитория, аудитория по ролям или пользователям требуют отдельно выданного news:global. Этот метод не загружает изображения и обложки: допустимы только уже существующие ресурсы новостей CRM.

## Доступ

`news:write` и право модератора управлять новостями в CRM. Для общей аудитории, ролей или конкретных пользователей дополнительно требуется `news:global`.

**Authorization** `string` *required*

Партнёрский Bearer-токен. Подробнее в разделе [«Авторизация»](https://docs.arzguard.com/cerberus-crm/authentication.md).

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

В примере создаётся черновик для указанного сервера. Для существующей новости возьмите её `version` из [актуального ответа](https://docs.arzguard.com/cerberus-crm/api/post-news-get.md) и используйте как `expected_version`.

## Параметры

**Idempotency-Key** `string` *required*

Уникальный ключ действия: от 16 до 128 печатных ASCII-символов без пробелов. При повторе того же запроса используйте тот же ключ. Для нового действия создайте новый. До 128 символов.

### Тело запроса

Передайте JSON с заголовком `Content-Type: application/json`.

**command** `object` *required*

Параметры действия.

**Поля**

**article** `object` *required*

Данные новости.

**Поля**

**audience** `object` *required*

Правила выбора аудитории новости.

**Поля**

**public** `boolean` *required*

Доступна ли новость всей аудитории. Для глобальных изменений требуется news:global.

**role\_ids** `string[] | null` *required*

Коды ролей аудитории новости.

**server\_ids** `string[] | null` *required*

Идентификаторы серверов. Для текущего бота возвращаются только согласованные серверы.

**user\_ids** `string[] | null` *required*

Идентификаторы пользователей аудитории новости.

**body** `JSON` *required*

Содержимое новости в структурированном формате редактора CRM.

**cover\_asset\_id** `string`

Идентификатор ресурса обложки новости.

**pinned** `boolean` *required*

Закреплена ли новость.

**theme** `string` *required*

Тема оформления новости.

**title** `string` *required*

Заголовок новости.

**expected\_version** `integer` *required*

Ожидаемая версия записи из последнего ответа API. Нужна для защиты от одновременных изменений.

**id** `string`

Идентификатор записи.

**operation** `string` *required*

Код выполняемой операции. Допустимые значения указаны в схеме. Допустимые значения `create`, `update`, `state`, `delete`.

**publish\_at** `string`

Запланированные дата и время публикации с часовым поясом.

Формат `date-time`.

**state** `string`

Целевое состояние записи. Допустимые значения определяются схемой и правилами CRM.

**moderator** `object` *required*

Модератор, который инициировал действие через бота. CRM определяет его аккаунт по привязанному внешнему ID и проверяет полномочия.

**Поля**

**platform\_user\_id** `string` *required*

ID модератора на выбранной платформе, строкой. Это ID пользователя, а не имя или ID бота. До 20 символов.

**provider** `string` *required*

Платформа модератора: discord — Discord, telegram — Telegram. Допустимые значения `discord`, `telegram`.

**server\_id** `string | integer` *required*

Уникальный номер сервера из GET /api/partner/v1/servers или UUID сервера. Сервер должен входить в выданный боту доступ.

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

HTTP `200`. Запрос выполнен успешно.

**article** `object`

Данные новости.

**Поля**

**audience** `object`

Правила выбора аудитории новости.

**Поля**

**public** `boolean` *required*

Доступна ли новость всей аудитории. Для глобальных изменений требуется news:global.

**role\_ids** `string[] | null` *required*

Коды ролей аудитории новости.

**server\_ids** `string[] | null` *required*

Идентификаторы серверов. Для текущего бота возвращаются только согласованные серверы.

**user\_ids** `string[] | null` *required*

Идентификаторы пользователей аудитории новости.

**audience\_users** `object[] | null`

Пользователи, относящиеся к аудитории новости.

**Поля**

**display\_name** `string` *required*

Отображаемое имя сотрудника.

**id** `string` *required*

Идентификатор записи.

**body** `JSON` *required*

Содержимое новости в структурированном формате редактора CRM.

**cover\_asset\_id** `string`

Идентификатор ресурса обложки новости.

**cover\_options** `object`

Настройки отображения обложки новости.

**Поля**

**builtin** `string`

Встроенная настройка или элемент справочника.

**full\_image** `boolean`

Показывать обложку новости полностью.

**logo\_asset\_id** `string`

Идентификатор ресурса логотипа новости.

**preset\_id** `string` *required*

Код оформления новости.

**server\_id** `string`

Идентификатор сервера CRM (UUID). Сервер должен входить в выданный боту доступ.

**created\_at** `string` *required*

Дата и время создания записи.

Формат `date-time`.

**created\_by** `object` *required*

Пользователь, создавший запись.

**Поля**

**avatar\_url** `string`

Ссылка на аватар пользователя или контекста.

**blocked** `boolean` *required*

Заблокирован ли пользователь в CRM.

**display\_name** `string` *required*

Отображаемое имя сотрудника.

**id** `string` *required*

Идентификатор записи.

**edited\_by** `object` *required*

Пользователь, изменивший запись.

**Поля**

**avatar\_url** `string`

Ссылка на аватар пользователя или контекста.

**blocked** `boolean` *required*

Заблокирован ли пользователь в CRM.

**display\_name** `string` *required*

Отображаемое имя сотрудника.

**id** `string` *required*

Идентификатор записи.

**id** `string` *required*

Идентификатор записи.

**pinned** `boolean` *required*

Закреплена ли новость.

**publish\_at** `string`

Запланированные дата и время публикации с часовым поясом.

Формат `date-time`.

**published\_at** `string`

Фактические дата и время публикации.

Формат `date-time`.

**published\_by** `object`

Пользователь, опубликовавший новость.

**Поля**

**avatar\_url** `string`

Ссылка на аватар пользователя или контекста.

**blocked** `boolean` *required*

Заблокирован ли пользователь в CRM.

**display\_name** `string` *required*

Отображаемое имя сотрудника.

**id** `string` *required*

Идентификатор записи.

**reading\_time\_minutes** `integer` *required*

Примерное время чтения новости в минутах.

**state** `string` *required*

Целевое состояние записи. Допустимые значения определяются схемой и правилами CRM.

**theme** `string` *required*

Тема оформления новости.

**title** `string` *required*

Заголовок новости.

**updated\_at** `string` *required*

Дата и время последнего изменения записи.

Формат `date-time`.

**version** `integer` *required*

Версия записи.

**deleted** `boolean` *required*

Была ли запись удалена.

## Ошибки

| HTTP | Значение |
| - | - |
| `400` | Некорректные параметры запроса. |
| `401` | Токен отсутствует, недействителен, отозван или не разрешён для этого IP-адреса. |
| `403` | Недостаточно прав у бота или указанного модератора; сервер или функция не входят в выданный доступ. |
| `404` | Запись не найдена или недоступна в данном контексте. |
| `409` | Конфликт состояния или ключа идемпотентности. Получите актуальную ревизию перед новым действием. |
| `413` | Размер тела запроса или загружаемого файла превышает допустимый предел. |
| `422` | Данные не прошли проверку формата или ограничений. Подробности находятся в поле errors. |
| `429` | Превышен лимит запросов. Дождитесь интервала, указанного в заголовке Retry-After. |
| `500` | Внутренняя ошибка сервера. |
| `503` | Сервис временно недоступен. Повторите запрос позднее. |

См. [формат ошибок и правила повторов](https://docs.arzguard.com/cerberus-crm/requests-and-errors.md).

## Пример

Подставьте свои ID, а для изменения используйте отдельный ключ операции и ревизию из CRM.

```bash cURL theme={null}
curl --request POST \
  --header "Authorization: Bearer $PARTNER_TOKEN" \
  --header "Idempotency-Key: $OPERATION_KEY" \
  --header 'Content-Type: application/json' \
  --data-binary '{
  "command": {
    "operation": "create",
    "expected_version": 0,
    "article": {
      "title": "Обновление правил модерации",
      "theme": "update",
      "pinned": false,
      "audience": {
        "public": false,
        "server_ids": [
          "01910000-0000-7000-8000-000000000001"
        ],
        "role_ids": [],
        "user_ids": []
      },
      "body": {
        "type": "doc",
        "content": [
          {
            "type": "paragraph",
            "content": [
              {
                "type": "text",
                "text": "Проверьте обновлённые правила модерации."
              }
            ]
          }
        ]
      }
    }
  },
  "moderator": {
    "provider": "discord",
    "platform_user_id": "123456789012345678"
  },
  "server_id": 102
}' \
  'https://test.crm.arzguard.com/api/partner/v1/news/actions'
```

```json HTTP 200, сокращённый ответ theme={null}
{
  "deleted": false,
  "article": {
    "id": "01910000-0000-7000-8000-000000000001",
    "state": "draft",
    "version": 1
  }
}
```


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