Fineguide icon

Fineguide

Interact with Fineguide REST API v1

Actions13

Session → Update

AI-generated

Summary

Update the human escalation status of a specified chat session linked to a given bot, enabling or disabling AI bot responses accordingly.

Inputs

  • Bot ID (required) — The identifier of the bot that owns the session.
  • Session ID (required) — The identifier of the session to update.
  • Human Escalated (required) — Boolean flag to enable (true) or disable (false) human escalation, which stops the AI bot from responding within the session.

Output shape

a single JSON object containing the updated session information returned from the API

The output reflects the session's updated properties. Errors throw exceptions unless 'continueOnFail' is enabled, resulting in error messages in the output.

Examples

Example 1: Enable human escalation for a session to pause AI responses and potentially route interaction to a human operator.

Set Bot ID, Session ID, and set Human Escalated to true.

Discussion