Skip to main content
PATCH
/
v0
/
chatbots
/
{chatbotId}
/
settings
/
user-data
Update Chatbot Settings - User Data
curl --request PATCH \
  --url https://sitegpt.ai/api/v0/chatbots/{chatbotId}/settings/user-data \
  --header 'Authorization: Bearer <token>' \
  --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
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 user-data settings of the chatbot

Request Body

​
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

OK

Success Response

​
success
boolean

Indicates whether this is success response or error response

​
message
string

Overall message regarding the operation performed

​
data
object

Data returned from the server