Skip to main content
POST
Create bot
Required scopes: agents-bot--my:rw

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json
name
string
required

The display name.

avatar
string

The avatar URL.

max_chats_count
integer
default:6

The maximum number of incoming chats that can be routed to the bot.

Required range: x <= 500
default_group_priority
enum<string>

The default routing priority for a group without a defined priority.

  • first — The highest chat routing priority. bots get chats before others from the same group. Corresponds to the bot priority option in the Text app.
  • normal — The medium chat routing priority. bots get chats before last-priority agents when no first-priority agents with free slots are available. Corresponds to the Primary priority option in the Text app.
  • last — The lowest chat routing priority. bots get chats when no agents with first or normal priority and free slots are available. Corresponds to the Secondary priority option in the Text app.
  • supervisor — Bots with the supervisor priority will not get any chats assigned automatically.
Available options:
first,
normal,
last,
supervisor
job_title
string

The bot's job title.

groups
object[]

Groups the bot belongs to.

type
string
default:chatbot

A custom value to categorize or identify the bot.

work_scheduler
object

The work scheduler options to set for the new bot.

owner_client_id
string

The Client ID that will own the bot. Required only when authorizing via Personal Access Tokens. When provided with a Bearer Token, the client_id associated with the Bearer Token will be ignored.

Response

200 - application/json

Bot created successfully.

id
string

Unique identifier of the created bot or bot template.

secret
string

The secret used to issue bot tokens via the Issue Bot Token method.