Create an Agent Bot

Create an agent bot in the account

Authorization

userApiKey

api_access_token<token>

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

In: header

Path Parameters

account_id*integer

The numeric ID of the account

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

The name of the agent bot

description?string

The description of the agent bot

outgoing_url?string

The webhook URL for the bot

avatar?file

Send the form data with the avatar image binary or use the avatar_url

avatar_url?string

The url to a jpeg, png file for the agent bot avatar

bot_type?integer

The type of the bot (0 for webhook)

bot_config?

The configuration for the bot

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/accounts/0/agent_bots" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": 0,
  "name": "string",
  "description": "string",
  "thumbnail": "string",
  "outgoing_url": "string",
  "bot_type": "string",
  "bot_config": {},
  "account_id": 0,
  "access_token": "string",
  "system_bot": true
}

{
  "description": "string",
  "errors": [
    {
      "field": "string",
      "message": "string",
      "code": "string"
    }
  ]
}

Authorization

Path Parameters

Request Body

Response Body

200application/json

401application/json

`application/json`

`application/json`