SiteGPT Docs home page

Create Your Chatbot Now
Support
Create Your Chatbot Now

Chatbot Settings

Update Chatbot Settings - Localization

Documentation

API Reference

API Documentation

Getting Started

Chatbot

GET
Fetch All Chatbots
POST
Create Chatbot
GET
Fetch Chatbot
DEL
Delete Chatbot

Chatbot Appearance

PATCH
Update Chatbot Appearance

Chatbot Custom Content

POST
Modify Chatbot Custom Content

Chatbot Follow Up Prompts

GET
Fetch All Follow Up Prompts
POST
Add Follow Up Prompt
GET
Fetch Follow Up Prompt
DEL
Delete Follow Up Prompt
PATCH
Update Follow Up Prompt

Chatbot Icons

POST
Update Chatbot Icons
DEL
Delete Chatbot Icons

Chatbot Links

GET
Fetch Links
POST
Add Links to Chatbot

Chatbot Messages

POST
Send Message
PATCH
Update Message

Chatbot Personas

GET
Fetch All Chatbot Personas
POST
Add Chatbot Persona
GET
Fetch Chatbot Persona
PATCH
Update Chatbot Persona
DEL
Delete Chatbot Persona
POST
Assign Persona to Chatbot

Chatbot Prompts

GET
Fetch All Chatbot Prompts
POST
Add Chatbot Prompt
GET
Fetch Chatbot Prompt
PATCH
Update Chatbot Prompt
DEL
Delete Chatbot Prompt
POST
Assign Prompt to Chatbot

Chatbot Quick Prompts

GET
Fetch All Quick Prompts
POST
Add Quick Prompt
GET
Fetch Quick Prompt
DEL
Delete Quick Prompt
PATCH
Update Quick Prompt

Chatbot Settings

PATCH
Update Chatbot Settings - Advanced
PATCH
Update Chatbot Settings - Chat Mode
PATCH
Update Chatbot Settings - General
PATCH
Update Chatbot Settings - Localization
PATCH
Update Chatbot Settings - User Data

Chatbot Threads

POST
Create Thread
GET
Fetch All Threads
GET
Fetch Thread
PATCH
Update Thread
POST
Escalate Conversation

Whitelabel

GET
Fetch Whitelabel Brands
GET
Fetch Whitelabel Brand
POST
Add Whitelabel User
GET
Fetch Whitelabel User
PATCH
Update Whitelabel User
PATCH
Generate API key for Whitelabel User

Chatbot Settings

Update Chatbot Settings - Localization

Update localization settings of the chatbot

PATCH

chatbots

{chatbotId}

settings

localization

Authorization

string

Bearer

Authorization

Required

string

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

chatbotId

string

chatbotId

Required

string

Id of the chatbot

object

Request Body

chatHome

object

chatHome

object

Localization settings for home screen in the chatbot

home

string

home

string

Text to be replaced for Home in home screen

addDetails

string

addDetails

string

Text to be replaced for Add details in home screen

startConversation

string

startConversation

string

Text to be replaced for Start a conversation in home screen

starting

string

starting

string

Text to be replaced for Starting... in home screen

chatMessages

object

chatMessages

object

Localization settings for messages screen in the chatbot

messages

string

messages

string

Text to be replaced for Messages in messages screen

noMessages

string

noMessages

string

Text to be replaced for No Messages in messages screen

loginToSeeHistory

string

loginToSeeHistory

string

Text to be replaced for Verify your email to save your conversation history. in messages screen

historyShowsUpHere

string

historyShowsUpHere

string

Text to be replaced for Your conversation history shows up here. in messages screen

verifyEmail

string

verifyEmail

string

Text to be replaced for Verify your email in messages screen

startConversation

string

startConversation

string

Text to be replaced for Start a conversation in messages screen

starting

string

starting

string

Text to be replaced for Starting... in messages screen

chatMessage

object

chatMessage

object

Localization settings for individual conversations in the chatbot

botName

string

botName

string

Text to be replaced for Bot in individual conversations

yourName

string

yourName

string

Text to be replaced for You in individual conversations

agentName

string

agentName

string

Text to be replaced for Agent in individual conversations

escalationHeading

string

escalationHeading

string

Text to be replaced for Are you sure you want to escalate the chat to human support? in individual conversations

escalationSubHeading

string

escalationSubHeading

string

Text to be replaced for This conversation will be shared with the human support and they will get back to you as soon as they can. in individual conversations

yesContinue

string

yesContinue

string

Text to be replaced for Yes, continue in individual conversations

cancel

string

cancel

string

Text to be replaced for Cancel in individual conversations

conversationEscalated

string

conversationEscalated

string

Text to be replaced for 👨‍💼 Conversation changed to human mode in individual conversations

chatAccount

object

chatAccount

object

Localization settings for account screen in the chatbot

account

string

account

string

Text to be replaced for Account in account screen

verifyEmail

string

verifyEmail

string

Text to be replaced for Verify your email in account screen

loginToSeeHistory

string

loginToSeeHistory

string

Text to be replaced for Verify your email to save your chat history in account screen

emailLabel

string

emailLabel

string

Text to be replaced for Email in account screen

nameLabel

string

nameLabel

string

Text to be replaced for Name in account screen

phoneLabel

string

phoneLabel

string

Text to be replaced for Phone Number in account screen

submit

string

submit

string

Text to be replaced for Submit in account screen

sendingOtp

string

sendingOtp

string

Text to be replaced for Sending OTP... in account screen

verifyOtp

string

verifyOtp

string

Text to be replaced for Verify OTP in account screen

sentOtpToEmail

string

sentOtpToEmail

string

Text to be replaced for We sent the OTP to your email address in account screen

otp

string

otp

string

Text to be replaced for OTP in account screen

verifyAndContinue

string

verifyAndContinue

string

Text to be replaced for Verify & Continue in account screen

notReceivedOtpYet

string

notReceivedOtpYet

string

Text to be replaced for Didn't receive OTP yet? in account screen

resend

string

resend

string

Text to be replaced for Resend in account screen

editDetails

string

editDetails

string

Text to be replaced for Edit Details in account screen

resetting

string

resetting

string

Text to be replaced for Resetting... in account screen

verifying

string

verifying

string

Text to be replaced for Verifying... in account screen

logout

string

logout

string

Text to be replaced for Logout in account screen

loggingOut

string

loggingOut

string

Text to be replaced for Logging out... in account screen

verified

string

verified

string

Text to be replaced for Verified in account screen

edit

string

edit

string

Text to be replaced for Edit in account screen

update

string

update

string

Text to be replaced for Update in account screen

updating

string

updating

string

Text to be replaced for Updating... in account screen

{
  "success": true,
  "message": "Updated localization settings of the chatbot successfully",
  "data": {}
}

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

chatbotId

string

required

Id of the chatbot

Body

application/json

Request Body

chatHome

object

Localization settings for home screen in the chatbot

chatHome.home

string

Text to be replaced for Home in home screen

chatHome.addDetails

string

Text to be replaced for Add details in home screen

chatHome.startConversation

string

Text to be replaced for Start a conversation in home screen

chatHome.starting

string

Text to be replaced for Starting... in home screen

chatMessages

object

Localization settings for messages screen in the chatbot

chatMessages.messages

string

Text to be replaced for Messages in messages screen

chatMessages.noMessages

string

Text to be replaced for No Messages in messages screen

chatMessages.loginToSeeHistory

string

Text to be replaced for Verify your email to save your conversation history. in messages screen

chatMessages.historyShowsUpHere

string

Text to be replaced for Your conversation history shows up here. in messages screen

chatMessages.verifyEmail

string

Text to be replaced for Verify your email in messages screen

chatMessages.startConversation

string

Text to be replaced for Start a conversation in messages screen

chatMessages.starting

string

Text to be replaced for Starting... in messages screen

chatMessage

object

Localization settings for individual conversations in the chatbot

chatMessage.botName

string

Text to be replaced for Bot in individual conversations

chatMessage.yourName

string

Text to be replaced for You in individual conversations

chatMessage.agentName

string

Text to be replaced for Agent in individual conversations

chatMessage.escalationHeading

string

Text to be replaced for Are you sure you want to escalate the chat to human support? in individual conversations

chatMessage.escalationSubHeading

string

Text to be replaced for This conversation will be shared with the human support and they will get back to you as soon as they can. in individual conversations

chatMessage.yesContinue

string

Text to be replaced for Yes, continue in individual conversations

chatMessage.cancel

string

Text to be replaced for Cancel in individual conversations

chatMessage.conversationEscalated

string

Text to be replaced for 👨‍💼 Conversation changed to human mode in individual conversations

chatAccount

object

Localization settings for account screen in the chatbot

chatAccount.account

string

Text to be replaced for Account in account screen

chatAccount.verifyEmail

string

Text to be replaced for Verify your email in account screen

chatAccount.loginToSeeHistory

string

Text to be replaced for Verify your email to save your chat history in account screen

chatAccount.emailLabel

string

Text to be replaced for Email in account screen

chatAccount.nameLabel

string

Text to be replaced for Name in account screen

chatAccount.phoneLabel

string

Text to be replaced for Phone Number in account screen

chatAccount.submit

string

Text to be replaced for Submit in account screen

chatAccount.sendingOtp

string

Text to be replaced for Sending OTP... in account screen

chatAccount.verifyOtp

string

Text to be replaced for Verify OTP in account screen

chatAccount.sentOtpToEmail

string

Text to be replaced for We sent the OTP to your email address in account screen

chatAccount.otp

string

Text to be replaced for OTP in account screen

chatAccount.verifyAndContinue

string

Text to be replaced for Verify & Continue in account screen

chatAccount.notReceivedOtpYet

string

Text to be replaced for Didn't receive OTP yet? in account screen

chatAccount.resend

string

Text to be replaced for Resend in account screen

chatAccount.editDetails

string

Text to be replaced for Edit Details in account screen

chatAccount.resetting

string

Text to be replaced for Resetting... in account screen

chatAccount.verifying

string

Text to be replaced for Verifying... in account screen

chatAccount.logout

string

Text to be replaced for Logout in account screen

chatAccount.loggingOut

string

Text to be replaced for Logging out... in account screen

chatAccount.verified

string

Text to be replaced for Verified in account screen

chatAccount.edit

string

Text to be replaced for Edit in account screen

chatAccount.update

string

Text to be replaced for Update in account screen

chatAccount.updating

string

Text to be replaced for Updating... in account screen

Response

200 - application/json

Success Response

success

boolean

Indicates whether this is success response or error response

message

string

Overall message regarding the operation performed

data

object | null

Data returned from the server

Was this page helpful?

Update Chatbot Settings - General Update Chatbot Settings - User Data

website twitter linkedin youtube

{
  "success": true,
  "message": "Updated localization settings of the chatbot successfully",
  "data": {}
}