Files
chatwoot/swagger/paths/application/inboxes/set_agent_bot.yml
2026-02-19 13:09:06 +05:30

68 lines
1.7 KiB
YAML

post:
tags:
- Inboxes
operationId: updateAgentBot
summary: Add or remove agent bot
security:
- userApiKey: []
description: To add an agent bot pass agent_bot id, to remove agent bot from an inbox pass null
x-codeSamples:
- lang: python
label: "Assign an agent bot"
source: |
from chatwoot import ChatwootClient
client = ChatwootClient(
base_url="https://app.chatwoot.com",
api_token="your-api-token"
)
client.inboxes.set_agent_bot(account_id=1, inbox_id=5, agent_bot_id=2)
- lang: python
label: "Remove agent bot"
source: |
from chatwoot import ChatwootClient
client = ChatwootClient(
base_url="https://app.chatwoot.com",
api_token="your-api-token"
)
client.inboxes.set_agent_bot(account_id=1, inbox_id=5, agent_bot_id=None)
parameters:
- $ref: '#/components/parameters/account_id'
- name: id
in: path
schema:
type: number
description: ID of the inbox
required: true
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- agent_bot
properties:
agent_bot:
type: number
description: 'Agent bot ID'
example: 1
responses:
'204':
description: Success
'404':
description: Inbox not found, Agent bot not found
content:
application/json:
schema:
$ref: '#/components/schemas/bad_request_error'
'403':
description: Access denied
content:
application/json:
schema:
$ref: '#/components/schemas/bad_request_error'