Обновить группу

PATCH /api/v1/knowledge-groups/{uniqueId}

Изменяет название и другие доступные поля группы. Если группа не найдена, возвращается 404; стандартную группу изменять нельзя.

URL

https://app.helpfy.ai/api/v1/knowledge-groups/{uniqueId}

Адрес своей установки подставьте вместо https://app.helpfy.ai. Идентификаторы в фигурных скобках замените значениями из ответов API.

Заголовки

Заголовок	Значение
Authorization	Basic <base64(email:api_key)>
Accept	application/json

Для JSON-тела передайте Content-Type: application/json.

Подробнее — авторизация API.

Параметры запроса

Параметры пути

Параметр	Тип	Обязательный	Описание
uniqueId	строка	Да	Идентификатор группы базы знаний.

Тело запроса (application/json)

Поле	Тип	Обязательно	Описание
bot_unique_id	строка	Нет	Уникальный идентификатор бота.
name	строка	Нет	Название группы базы знаний.

Пример запроса

curl --request PATCH 'https://app.helpfy.ai/api/v1/knowledge-groups/11111111-1111-4111-8111-111111111111' \
  --user 'user@example.com:api_key' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data-binary @- <<'JSON'
{
  "bot_unique_id": "11111111-1111-4111-8111-111111111111",
  "name": "My new group"
}
JSON

Ответы

HTTP	Описание
200	Данные обновлённой группы базы знаний.
400	Стандартную группу изменить нельзя либо переданы неверные параметры.
404	Группа базы знаний не найдена.

Пример ответа — HTTP 200

Сокращённый пример; показаны клиентские поля. Значения условные.

{
  "unique_id": "17396bcc-6b29-4b2e-b7fd-63c8eb8b6cc8",
  "name": "My new group",
  "is_default": false,
  "created_at": "2024-10-18T14:13:46.180Z",
  "updated_at": "2024-10-18T14:13:46.180Z"
}

Пример ошибки — HTTP 400

Пример структуры ошибки. Код и сообщение зависят от причины ошибки.

{
  "statusCode": 400,
  "error": "Bad Request",
  "code": "BAD_REQUEST",
  "message": "Bad Request"
}