PATCH
/
platform
/
api
/
v1
/
agent_bots
/
{id}
curl --request PATCH \
  --url https://app.chatwoot.com/platform/api/v1/agent_bots/{id} \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '{
  "name": "My Agent Bot",
  "description": "This is a sample agent bot",
  "outgoing_url": "https://example.com/webhook",
  "account_id": 1,
  "avatar_url": "https://example.com/avatar.png"
}'
{
  "id": 123,
  "name": "<string>",
  "description": "<string>",
  "thumbnail": "<string>",
  "outgoing_url": "<string>",
  "bot_type": "<string>",
  "bot_config": {},
  "account_id": 123,
  "access_token": "<string>",
  "system_bot": true
}

Authorizations

​
api_access_token
string
header
required

This token can be obtained by the system admin after creating a platformApp. This token should be used to provision agent bots, accounts, users and their roles.

Path Parameters

​
id
integer
required

The ID of the agentbot to be updated

Body

application/json

Response

200
application/json

Success

The response is of type object.