Set Chatbot Config

post

https://api.elephant.ai/api/v1/set-chatbot-config

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

chatbot_id

string

required

Body Params

bot_mode

string

Defaults to AI + Human

This has to be either AI, AI + Human or Human

hero_img

timezone

string

Timezone of the chatbot

chat_icon

string

Defaults to https://res.cloudinary.com/dnkz9luqz/image/upload/v1721280234/y5bbzujtx8wa2dwepkv9.svg

This will be the icon that will be shown on the chatbot

tabs_name

array of strings

Defaults to Home,Messages,Tickets,Help

This will be the name of the tabs that will be shown on the chatbot

Tabs Name

help_title

string

Defaults to Search for help

hero_title

array of strings

Defaults to Hey there ðŸ‘‹,How can we help?

Hero Title

logo_image

string

This will be the logo image that will be shown on the chatbot

text_color

string

Defaults to #000000

voice_note

boolean

Defaults to false

This will enable the voice note feature in the chatbot

help_active

boolean

Defaults to true

leads_field

array of objects

Defaults to [object Object],[object Object],[object Object]

Leads Field

send_images

boolean

Defaults to false

This will enable the feature to send images in the chatbot

side_margin

integer

Defaults to 20

theme_color

string

Defaults to #1219f3

webhook_url

string

display_name

string

This will be the display name of the chatbot

header_color

string

Defaults to #1219f3

hide_on_urls

array of strings

Defaults to []

This will be the urls on which the chatbot will be hidden

Hide On Urls

show_sources

boolean

Defaults to false

This will enable the feature to show message context sources in the chatbot

allow_on_urls

array of strings

Defaults to []

This will be the urls on which the chatbot will be shown

Allow On Urls

audio_message

boolean

Defaults to false

This will enable the audio message feature in the chatbot

bottom_margin

integer

Defaults to 20

This will be the bottom margin of the chatbot

message_sound

boolean

Defaults to true

This will enable the message sound feature in the chatbot

showPoweredBy

boolean

Defaults to true

This will show/hide the powered by text in the chatbot

show_feedback

boolean

Defaults to true

This will show/hide the feedback buttons in the chatbot

talk_to_human

boolean

Defaults to true

auto_responder

array of strings

Defaults to Hi, we will soon connect you to a human agent. Please drop your query.

These messages will appear as standard responses from the chatbot when a user escaltes a conversation.

Auto Responder

chat_icon_name

string

Defaults to logo elephant.png

webhook_events

object

hero_image_name

logo_image_name

string

powered_by_link

string

Defaults to https://elephant.ai/

This will be the link that will be opened when the powered by text is clicked

powered_by_text

string

Defaults to Powered by Elephant.ai

This will be the text that will be shown in the powered by text

profile_picture

string

Defaults to https://res.cloudinary.com/dnkz9luqz/image/upload/v1721280234/y5bbzujtx8wa2dwepkv9.svg

This will be the profile picture that will be shown on the chatbot

background_color

string

Defaults to #ffffff

hero_title_color

string

Defaults to #ffffff

hover_text_color

string

Defaults to #1219f3

initial_messages

array of strings

Defaults to Hi, What can I help you with?

These messages will appear as standard responses from the chatbot when a conversation is started.

Initial Messages

visibility_pages

boolean

Defaults to false

announcementTitle

string

Defaults to Want to Make an Announcement? The Headline Goes Here.

chat_bubble_align

string

Defaults to right

This will set the alignment of the chat bubble to right or left

header_text_color

string

Defaults to #ffffff

hero_image_active

boolean

Defaults to false

human_popup_title

string

Defaults to Are you sure you want to escalate the chat to human support?

chatbot_icon_color

string

Defaults to #1219f3

chats_notification

boolean

Defaults to false

leads_notification

boolean

Defaults to false

send_message_title

string

Defaults to Send us a message

suggested_messages

array of strings

Defaults to []

Suggested Messages

user_message_color

string

Defaults to #1219f3

announcement_active

boolean

Defaults to true

human_popup_message

string

Defaults to This conversation will be shared with the human support and they will get back to you as soon as they can.

message_placeholder

string

Defaults to Send a message

visibility_on_pages

boolean

Defaults to false

chatbot_header_image

string

Defaults to https://res.cloudinary.com/dnkz9luqz/image/upload/v1721280234/y5bbzujtx8wa2dwepkv9.svg

profile_picture_name

string

Defaults to logo elephant.png

recent_message_title

string

Defaults to Recent Message

initial_message_popup

boolean

Defaults to true

description_text_color

string

Defaults to #737373

hover_background_color

string

Defaults to #e5eeff

feedback_negative_color

string

Defaults to #F03D3D

feedback_positive_color

string

Defaults to #02c502

start_conversation_text

string

Defaults to Start a Conversation

user_message_text_color

string

Defaults to #ffffff

hero_img_icon_link1_name

hero_img_icon_link2_name

hero_img_icon_link3_name

home_send_message_active

boolean

Defaults to true

send_message_description

string

Defaults to We typically reply within a few minutes

chatbot_header_image_name

string

Defaults to logo elephant.png

hero_corner_images_active

boolean

Defaults to true

leads_instant_notification

boolean

Defaults to false

initial_message_popup_delay

string

Defaults to 5

recent_message_title_active

boolean

Defaults to true

escalated_chats_notification

boolean

Defaults to true

Headers

token

string

required

Responses

200Successful Response

422Validation Error