Put botsbotidbotanalyzerbotanalyzerrequestidstop

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14107861793.8 KB

Cancels an ongoing bot analysis execution. Once stopped, the analysis cannot be resumed and no recommendations will be generated.

put/bots/{botId}/botanalyzer/{botAnalyzerRequestId}/stop/

Path parameters

botIdstring required

The unique identifier of the bot.

botAnalyzerRequestIdstring required

The unique identifier of the analysis request to stop.

Response

Success

botIdstring

The unique identifier of the bot.

botVersionstring

The version of the bot.

localeIdstring

The locale identifier of the bot locale.

botAnalyzerStatus'Processing' | 'Available' | 'Failed' | 'Stopping' | 'Stopped'

<p>The updated status of the analysis. The status will be <code>Stopping</code> and will eventually transition to <code>Stopped</code>.</p> <p>Valid Values: <code>Processing | Available | Failed | Stopping | Stopped</code> </p>

botAnalyzerRequestIdstring

The unique identifier of the analysis request.