Skip to main content
POST
/
bots
Create bot
curl --request POST \
  --url https://api.helloannie.com/v1/bots \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Alex",
  "internalName": "orthodontic_bot",
  "external_id": "customer_456_bot"
}
'
{
  "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"
    ]
  }
}

Body

application/json
​
name
string

The bot's given name

Required string length: 1 - 100
Example:

"Alex"

​
internalName
string

Internal identifier to categorize the bot type

Required string length: 1 - 100
Example:

"orthodontic_bot"

​
external_id
string | null

Optional external identifier from client's system

Maximum string length: 255
Example:

"customer_456_bot"

Response

201 - application/json

Created

​
data
object