Skip to main content
POST
/
create_bot
Create a new bot
curl --request POST \
  --url https://botsettings.messagesimproved.com/create_bot \
  --header 'Content-Type: application/json' \
  --header 'admin-email: <admin-email>' \
  --header 'api-key: <api-key>' \
  --data '{
  "name": "BobBot",
  "openingMessage": "Hello! How can I assist you today?",
  "prompt": "Please assist users with common queries about our services."
}'
{
  "bot_id": "74b96c5b-7376-430c-a6d7-b78cfd6aa32c"
}

Headers

api-key
string
required

API key for authentication.

admin-email
string
required

Email of the admin making the request.

Body

application/json
name
string
required

The name of the bot.

Example:

"BobBot"

openingMessage
string
required

The initial message that the bot will send.

Example:

"Hello! How can I assist you today?"

prompt
string
required

The prompt that defines the bot's behavior.

Example:

"Please assist users with common queries about our services."

Response

Bot created successfully

bot_id
string

Unique identifier for the newly created bot.

Example:

"74b96c5b-7376-430c-a6d7-b78cfd6aa32c"

I