Skip to main content
Stop Bot

Authorizations

Authorization
string
header
required

Your API key from pailflow.com

Path Parameters

bot_id
string<uuid>
required

The bot ID returned from POST /api/bot/join

Response

Bot stop request sent successfully

status
string

Status indicating the leave request was sent

Example:

"leave_requested"

bot_id
string<uuid>

The bot ID for which leave was requested

Example:

"258b06fc-6bc9-4261-9f29-bc8a4474af0a"

message
string

Informational message about the stop request

Example:

"Bot stop request sent. Bot will exit within 5 seconds."