Agents

Switch a BotInstance on or off (v2)

Sets the BotInstance's status. Allowed for the agent's owner, whoever manages the bot's App (its creator, an admin with appSettings.update, a B2B Server JWT for it) and isSuperAdmin.write; anyone else gets 403. An off bot stays in its rooms but does not answer. The AI service is told straight away (best-effort). Supports User JWT and B2B Server JWT.

post/v2/bot-instances/{id}/status

Request

  • Base URL: https://api.chat.ethora.com
  • URL: https://api.chat.ethora.com/v2/bot-instances/{id}/status
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring required

BotInstance id

Request body

status'on' | 'off' required

Response 

{ ok: true, botInstance: { id, agentId, appId, userId, xmppUsername, status, joinedRooms, lastActiveAt, createdAt, updatedAt } }

Changes

No recorded changes to this operation across all 1 revision of this API.