API Documentation
Chatbot Appearance
Chatbot Custom Content
Chatbot Follow Up Prompts
Chatbot Icons
Chatbot Links
Chatbot Messages
Chatbot Personas
Chatbot Prompts
Chatbot Quick Prompts
Chatbot Settings
Chatbot Threads
Update Whitelabel User
Update user of your whitelabel brand.
Pre-requisities:
- You have to be a whitelabel customer in SiteGPT.
- You need to create and configure your own brand in SiteGPT dashboard.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Id of the whitelabel user
Id of the whitelabel brand
Chatbots quota to be assigned to the user
Links quota to be assigned to the user
Files quota to be assigned to the user
Combined messages quota to be assigned to the user
Members quota to be assigned to the user
Features to be enabled/disabled for the user. You can enable/disable only those features which are enabled for the whitelabel brand owner.
Indicates whether the watermark feature to be enabled/disabled.
Pre Requisities:
- Brand owner needs to have access to this feature.
Indicates whether the api feature to be enabled/disabled.
Pre Requisities:
- Brand owner needs to have access to this feature.
Indicates whether the webhooks feature to be enabled/disabled.
Pre Requisities:
- Brand owner needs to have access to this feature.
Indicates whether the functions feature to be enabled/disabled.
Pre Requisities:
- Brand owner needs to have access to this feature.
Indicates whether the integrations feature to be enabled/disabled.
Pre Requisities:
- Brand owner needs to have access to this feature.
- API key needs to be generated.
- API feature flag should be enabled.
Indicates whether the google chat feature to be enabled/disabled.
Pre Requisities:
- Brand owner needs to have access to this feature.
- Integrations feature should be enabled.
Indicates whether the messenger chat feature to be enabled/disabled.
Pre Requisities:
- Brand owner needs to have access to this feature.
- Integrations feature should be enabled.
Indicates whether the crisp chat feature to be enabled/disabled.
Pre Requisities:
- Brand owner needs to have access to this feature.
- Integrations feature should be enabled.
Indicates whether the slack chat feature to be enabled/disabled.
Pre Requisities:
- Brand owner needs to have access to this feature.
- Integrations feature should be enabled.
Indicates whether the zendesk chat feature to be enabled/disabled.
Pre Requisities:
- Brand owner needs to have access to this feature.
- Integrations feature should be enabled.
{
"success": true,
"message": "Updated the whitelabel user of the brand successfully",
"data": {
"whitelabelUser": {
"id": "332153612345906321",
"brandId": "332110515123458123",
"email": "user@example.com",
"name": "",
"profilePic": "",
"chatbotsQuota": 2,
"linksQuota": 20,
"filesQuota": 5,
"combinedMessagesQuota": 25,
"membersQuota": 2,
"features": {
"watermark": false,
"api": true,
"webhooks": false,
"functions": false,
"integrations": false,
"googleChatIntegration": false,
"messengerChatIntegration": false,
"crispChatIntegration": false,
"slackChatIntegration": false,
"zendeskChatIntegration": false
},
"createdAt": "2024-02-05T13:35:44.155845Z",
"updatedAt": "2024-02-05T13:35:44.155845Z"
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Id of the whitelabel user
Id of the whitelabel brand
Body
Chatbots quota to be assigned to the user
x > 0Links quota to be assigned to the user
x > 0Files quota to be assigned to the user
x > 0Combined messages quota to be assigned to the user
x > 0Members quota to be assigned to the user
x > 0Features to be enabled/disabled for the user. You can enable/disable only those features which are enabled for the whitelabel brand owner.
Indicates whether the watermark feature to be enabled/disabled.
Pre Requisities:
- Brand owner needs to have access to this feature.
Indicates whether the api feature to be enabled/disabled.
Pre Requisities:
- Brand owner needs to have access to this feature.
Indicates whether the webhooks feature to be enabled/disabled.
Pre Requisities:
- Brand owner needs to have access to this feature.
Indicates whether the functions feature to be enabled/disabled.
Pre Requisities:
- Brand owner needs to have access to this feature.
Indicates whether the integrations feature to be enabled/disabled.
Pre Requisities:
- Brand owner needs to have access to this feature.
- API key needs to be generated.
- API feature flag should be enabled.
Indicates whether the google chat feature to be enabled/disabled.
Pre Requisities:
- Brand owner needs to have access to this feature.
- Integrations feature should be enabled.
Indicates whether the messenger chat feature to be enabled/disabled.
Pre Requisities:
- Brand owner needs to have access to this feature.
- Integrations feature should be enabled.
Indicates whether the crisp chat feature to be enabled/disabled.
Pre Requisities:
- Brand owner needs to have access to this feature.
- Integrations feature should be enabled.
Indicates whether the slack chat feature to be enabled/disabled.
Pre Requisities:
- Brand owner needs to have access to this feature.
- Integrations feature should be enabled.
Indicates whether the zendesk chat feature to be enabled/disabled.
Pre Requisities:
- Brand owner needs to have access to this feature.
- Integrations feature should be enabled.
Response
Indicates whether this is success response or error response
Overall message regarding the operation performed
Data returned from the server
Whitelabel User
Id of the whitelabel user
Id of the brand which whitelabel user belongs to
Email of the whitelabel user
Name of the whitelabel user
Profile picture url of the whitelabel user
Chatbots quota of the whitelabel user
Links quota of the whitelabel user
Files quota of the whitelabel user
Messages quota of the whitelabel user
Members quota of the whitelabel user
API key of the whitelabel user
Features of Whitelabel User
Indicates whether the watermark feature is enabled or not
Indicates whether the api feature is enabled or not
Indicates whether the webhooks feature is enabled or not
Indicates whether the functions feature is enabled or not
Indicates whether the integrations feature is enabled or not
Indicates whether the google chat feature is enabled or not
Indicates whether the messenger chat feature is enabled or not
Indicates whether the crisp chat feature is enabled or not
Indicates whether the slack chat feature is enabled or not
Indicates whether the zendesk chat feature is enabled or not
Timestamp at which the whitelabel user has been created
Timestamp at which the whitelabel user has been recently updated
Was this page helpful?
{
"success": true,
"message": "Updated the whitelabel user of the brand successfully",
"data": {
"whitelabelUser": {
"id": "332153612345906321",
"brandId": "332110515123458123",
"email": "user@example.com",
"name": "",
"profilePic": "",
"chatbotsQuota": 2,
"linksQuota": 20,
"filesQuota": 5,
"combinedMessagesQuota": 25,
"membersQuota": 2,
"features": {
"watermark": false,
"api": true,
"webhooks": false,
"functions": false,
"integrations": false,
"googleChatIntegration": false,
"messengerChatIntegration": false,
"crispChatIntegration": false,
"slackChatIntegration": false,
"zendeskChatIntegration": false
},
"createdAt": "2024-02-05T13:35:44.155845Z",
"updatedAt": "2024-02-05T13:35:44.155845Z"
}
}
}