PATCH
/
v0
/
chatbots
/
{chatbotId}
/
settings
/
general
curl --request PATCH \
  --url https://sitegpt.ai/api/v0/chatbots/{chatbotId}/settings/general \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "chatbotDescription": "This is a test chatbot",
  "disableSmartFollowUpPrompts": false,
  "smartFollowUpPromptsCount": 3,
  "disableLeadNotifications": true,
  "historyCount": 4,
  "gptModel": "gpt-3.5-turbo"
}'
{
  "success": true,
  "message": "Updated general settings of the chatbot successfully",
  "data": {}
}

Authorizations

​
Authorization
string
header
required

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 to update general settings of the chatbot

Request Body

​
chatbotDescription
string

Description of the chatbot

​
disableSmartFollowUpPrompts
boolean

Option to disable smart followup questions generated by SiteGPT

​
smartFollowUpPromptsCount
integer
default:
3

Number of smart follow up questions to be shown when enabled.

Required range: 1 < x < 5Must be a multiple of 1
​
disableLeadNotifications
boolean

Option to disable email notifications for new lead captures.

​
historyCount
integer

Number of history messages to be considered when answering the question

Required range: 1 < x < 5Must be a multiple of 1
​
gptModel
enum<string>

All available GPT models

Available options:
gpt-3.5-turbo,
gpt-4
​
extraData
string

Any extra data you want to add to your chatbot.

​
metadata
object

Any metadata (key-value pairs) that you can assign to the chatbot. Key should be string and Value could be anything.

Response

200
application/json
OK

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 - Chat ModeUpdate Chatbot Settings - Localization