Обновить сценарий

PATCH /api/v1/bots/{uniqueId}/scenarios/{scenarioUniqueId}

URL

https://app.helpfy.ai/api/v1/bots/{uniqueId}/scenarios/{scenarioUniqueId}

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

Заголовки

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

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

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

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

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

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

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

Поле	Тип	Обязательно	Описание
title	строка	Нет	Название сценария.
clarification_label	строка	Нет	Короткое название темы, которое клиент увидит при уточнении.
description	строка	Нет	Понятное описание назначения.
trigger_description	строка	Нет	Краткое описание ситуации клиента, при которой нужно запустить сценарий.
examples	массив: строка	Нет	Примеры обращений, при которых нужно запускать сценарий.
exclusions	массив: строка	Нет	Примеры обращений, при которых сценарий запускаться не должен.
min_confidence	число	Нет	Минимальная оценка соответствия обращения для запуска сценария. Чем выше значение, тем строже выбор. (минимум: 50; максимум: 100; по умолчанию: 78)
priority	число	Нет	Приоритет выбора сценария среди подходящих. (по умолчанию: 100)
allow_repeat_in_dialogue	логическое значение	Нет	Разрешить повторный запуск сценария в одном диалоге. (по умолчанию: false)
exit_message	строка или null	Нет	Ответ при явном выходе клиента из сценария. Пустое значение или null возвращает стандартный ответ. (максимум символов: 2000)
definition	объект	Нет	Схема блоков сценария и переходов между ними.
layout	объект	Нет	Расположение блоков в конструкторе сценария.

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

curl --request PATCH 'https://app.helpfy.ai/api/v1/bots/11111111-1111-4111-8111-111111111111/scenarios/11111111-1111-4111-8111-111111111111' \
  --user 'user@example.com:api_key' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data-binary @- <<'JSON'
{
  "title": "Возврат заказа",
  "clarification_label": "Жду возврат денег"
}
JSON

Ответы

HTTP	Описание
200	Успешный ответ
400	Неверные настройки сценария.
401	Требуется авторизация.
403	Нет доступа к боту.
404	Бот или сценарий не найден.

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

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

{
  "unique_id": "17396bcc-6b29-4b2e-b7fd-63c8eb8b6cc8",
  "title": "Статус доставки",
  "trigger_description": "Клиент спрашивает о текущем статусе доставки своего заказа",
  "min_confidence": 78,
  "priority": 100,
  "is_active": false,
  "allow_repeat_in_dialogue": false,
  "versions": [
    {
      "unique_id": "17396bcc-6b29-4b2e-b7fd-63c8eb8b6cc8",
      "version": 2,
      "status": "DRAFT",
      "definition": {
        "start_node_id": "answer",
        "nodes": [
          {
            "id": "answer",
            "type": "FIXED_REPLY",
            "title": "Ответить клиенту",
            "text": "Адрес доставки можно изменить до передачи заказа в доставку."
          },
          {
            "id": "end",
            "type": "END",
            "title": "Завершить сценарий"
          }
        ],
        "edges": [
          {
            "id": "answer-end",
            "source": "answer",
            "target": "end",
            "priority": 100,
            "condition": {
              "type": "ALWAYS"
            }
          }
        ]
      },
      "created_at": "2026-10-16T09:00:00.000Z"
    }
  ],
  "_count": {
    "runs": 12
  },
  "created_at": "2026-10-16T09:00:00.000Z",
  "updated_at": "2026-10-16T09:00:00.000Z"
}

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

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

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