Удалить диалог

DELETE /api/v1/bots/{botUniqueId}/dialogues/{dialogueId}

Удаляет диалог. Если диалог не найден, возвращается 404.

URL

https://app.helpfy.ai/api/v1/bots/{botUniqueId}/dialogues/{dialogueId}

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

Заголовки

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

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

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

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

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

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

curl --request DELETE 'https://app.helpfy.ai/api/v1/bots/11111111-1111-4111-8111-111111111111/dialogues/11111111-1111-4111-8111-111111111111' \
  --user 'user@example.com:api_key' \
  --header 'Accept: application/json'

Ответы

HTTP	Описание
200	Успешный ответ
404	Диалог не найден.

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

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

{
  "unique_id": "17396bcc-6b29-4b2e-b7fd-63c8eb8b6cc8",
  "dialogue_id": "17396bcc-6b29-4b2e-b7fd-63c8eb8b6cc8",
  "name": "My new dialogue",
  "message_limit": 20,
  "operator_limit": 25,
  "successful_messages": 5,
  "clarification_attempted": false,
  "is_active": true,
  "created_at": "2024-10-18T09:17:43.552Z",
  "updated_at": "2024-10-18T09:17:43.552Z"
}