Chatbot Settings
Update Chatbot Settings - User Data
Update user-data settings of the chatbot
PATCH
/
v0
/
chatbots
/
{chatbotId}
/
settings
/
user-data
Authorization
Path
Body
curl --request PATCH \
--url https://sitegpt.ai/api/v0/chatbots/{chatbotId}/settings/user-data \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"collectUserDetails": "DO_NOT_COLLECT",
"collectName": false,
"collectPhone": false
}'
{
"success": true,
"message": "Updated user-data settings of the chatbot successfully",
"data": {}
}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
chatbotId
string
requiredId of the chatbot
Body
application/json
collectUserDetails
enum<string>
Options whether to collect user details or not
Available options:
MANDATORY
, OPTIONAL
, DO_NOT_COLLECT
collectName
boolean
Indicates whether to collect user name or not
collectPhone
boolean
Indicates whether to collect user phone number or not
Response
200 - application/json
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?
curl --request PATCH \
--url https://sitegpt.ai/api/v0/chatbots/{chatbotId}/settings/user-data \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"collectUserDetails": "DO_NOT_COLLECT",
"collectName": false,
"collectPhone": false
}'
{
"success": true,
"message": "Updated user-data settings of the chatbot successfully",
"data": {}
}