Update Whitelabel User

curl --request PATCH \
  --url https://sitegpt.ai/api/v0/w/brands/{brandId}/users/{userId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "chatbotsQuota": 1,
  "linksQuota": 100,
  "filesQuota": 25,
  "combinedMessagesQuota": 250,
  "membersQuota": 2,
  "features": {
    "api": true
  }
}
'

{
  "success": true,
  "message": "Updated the whitelabel user of the brand successfully",
  "data": {
    "whitelabelUser": {
      "id": "332153612345906321",
      "brandId": "332110515123458123",
      "email": "[email protected]",
      "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"
    }
  }
}

PATCH

brands

{brandId}

users

{userId}

Update Whitelabel User

curl --request PATCH \
  --url https://sitegpt.ai/api/v0/w/brands/{brandId}/users/{userId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "chatbotsQuota": 1,
  "linksQuota": 100,
  "filesQuota": 25,
  "combinedMessagesQuota": 250,
  "membersQuota": 2,
  "features": {
    "api": true
  }
}
'

{
  "success": true,
  "message": "Updated the whitelabel user of the brand successfully",
  "data": {
    "whitelabelUser": {
      "id": "332153612345906321",
      "brandId": "332110515123458123",
      "email": "[email protected]",
      "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

Authorization

string

header

required

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

Path Parameters

userId

string

required

Id of the whitelabel user

brandId

string

required

Id of the whitelabel brand

Body

application/json

Request body to update the whitelabel user of your brand.

chatbotsQuota

integer

Chatbots quota to be assigned to the user

Required range: x >= 0

linksQuota

integer

Links quota to be assigned to the user

Required range: x >= 0

filesQuota

integer

Files quota to be assigned to the user

Required range: x >= 0

combinedMessagesQuota

integer

Combined messages quota to be assigned to the user

Required range: x >= 0

membersQuota

integer

Members quota to be assigned to the user

Required range: x >= 0

features

object

Features to be enabled/disabled for the user. You can enable/disable only those features which are enabled for the whitelabel brand owner.

Show child attributes

features.watermark

boolean

Indicates whether the watermark feature to be enabled/disabled.

Pre Requisities:

Brand owner needs to have access to this feature.

features.api

boolean

Indicates whether the api feature to be enabled/disabled.

Pre Requisities:

Brand owner needs to have access to this feature.

features.webhooks

boolean

Indicates whether the webhooks feature to be enabled/disabled.

Pre Requisities:

Brand owner needs to have access to this feature.

features.functions

boolean

Indicates whether the functions feature to be enabled/disabled.

Pre Requisities:

Brand owner needs to have access to this feature.

features.integrations

boolean

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.

features.googleChatIntegration

boolean

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.

features.messengerChatIntegration

boolean

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.

features.crispChatIntegration

boolean

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.

features.slackChatIntegration

boolean

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.

features.zendeskChatIntegration

boolean

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

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

Show child attributes

data.whitelabelUser

Whitelabel-User · object

Whitelabel User

Show child attributes

data.whitelabelUser.id

string

Id of the whitelabel user

data.whitelabelUser.brandId

string

Id of the brand which whitelabel user belongs to

data.whitelabelUser.email

string

Email of the whitelabel user

data.whitelabelUser.name

string

Name of the whitelabel user

data.whitelabelUser.profilePic

string

Profile picture url of the whitelabel user

data.whitelabelUser.chatbotsQuota

integer

Chatbots quota of the whitelabel user

data.whitelabelUser.linksQuota

integer

Links quota of the whitelabel user

data.whitelabelUser.filesQuota

integer

Files quota of the whitelabel user

data.whitelabelUser.combinedMessagesQuota

integer

Messages quota of the whitelabel user

data.whitelabelUser.membersQuota

integer

Members quota of the whitelabel user

data.whitelabelUser.apiKey

string

API key of the whitelabel user

data.whitelabelUser.features

WhitelabelUserFeatures · object

Features of Whitelabel User

Show child attributes

data.whitelabelUser.features.watermark

boolean

Indicates whether the watermark feature is enabled or not

data.whitelabelUser.features.api

boolean

Indicates whether the api feature is enabled or not

data.whitelabelUser.features.webhooks

boolean

Indicates whether the webhooks feature is enabled or not

data.whitelabelUser.features.functions

boolean

Indicates whether the functions feature is enabled or not

data.whitelabelUser.features.integrations

boolean

Indicates whether the integrations feature is enabled or not

data.whitelabelUser.features.googleChatIntegration

boolean

Indicates whether the google chat feature is enabled or not

data.whitelabelUser.features.messengerChatIntegration

boolean

Indicates whether the messenger chat feature is enabled or not

data.whitelabelUser.features.crispChatIntegration

boolean

Indicates whether the crisp chat feature is enabled or not

data.whitelabelUser.features.slackChatIntegration

boolean

Indicates whether the slack chat feature is enabled or not

data.whitelabelUser.features.zendeskChatIntegration

boolean

Indicates whether the zendesk chat feature is enabled or not

data.whitelabelUser.createdAt

string<date-time>

Timestamp at which the whitelabel user has been created

data.whitelabelUser.updatedAt

string<date-time>

Timestamp at which the whitelabel user has been recently updated

Fetch Whitelabel User Generate API key for Whitelabel User

⌘I

API Documentation

Chatbot

Chatbot Appearance

Chatbot Custom Content

Chatbot Conversation Followups

Chatbot Icons

Chatbot Messages

Chatbot Personas

Chatbot Instructions

Chatbot Conversation Starters

Chatbot Settings

Chatbot Threads

Whitelabel

Update Whitelabel User

Authorizations

Path Parameters

Body

Response