Skip to main content
PATCH
/
bots
/
{id}
Update bot
curl --request PATCH \
  --url https://api.helloannie.com/v1/bots/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Steve",
  "internalName": "pediatric_bot",
  "external_id": "updated_customer_ref"
}
'
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Susan",
    "internalName": "general_practice_bot",
    "external_id": "practice_123_main_bot",
    "childBots": [
      "550e8400-e29b-41d4-a716-446655440001",
      "550e8400-e29b-41d4-a716-446655440002"
    ]
  }
}

Path Parameters

id
string<uuid>
required

Body

application/json
name
string

The bot's given name

Required string length: 1 - 100
Example:

"Steve"

internalName
string

Internal identifier to categorize the bot type

Required string length: 1 - 100
Example:

"pediatric_bot"

external_id
string | null

Optional external identifier from client's system

Maximum string length: 255
Example:

"updated_customer_ref"

Response

200 - application/json

OK

data
object