Skip to main content
POST
/
v0
/
w
/
brands
/
{brandId}
/
users
Add Whitelabel User
curl --request POST \
  --url https://sitegpt.ai/api/v0/w/brands/{brandId}/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "user@example.com",
  "chatbotsQuota": 1,
  "linksQuota": 100,
  "filesQuota": 25,
  "combinedMessagesQuota": 250,
  "membersQuota": 2
}
'
import requests

url = "https://sitegpt.ai/api/v0/w/brands/{brandId}/users"

payload = {
"email": "user@example.com",
"chatbotsQuota": 1,
"linksQuota": 100,
"filesQuota": 25,
"combinedMessagesQuota": 250,
"membersQuota": 2
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: 'user@example.com',
chatbotsQuota: 1,
linksQuota: 100,
filesQuota: 25,
combinedMessagesQuota: 250,
membersQuota: 2
})
};

fetch('https://sitegpt.ai/api/v0/w/brands/{brandId}/users', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://sitegpt.ai/api/v0/w/brands/{brandId}/users",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => 'user@example.com',
'chatbotsQuota' => 1,
'linksQuota' => 100,
'filesQuota' => 25,
'combinedMessagesQuota' => 250,
'membersQuota' => 2
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://sitegpt.ai/api/v0/w/brands/{brandId}/users"

payload := strings.NewReader("{\n \"email\": \"user@example.com\",\n \"chatbotsQuota\": 1,\n \"linksQuota\": 100,\n \"filesQuota\": 25,\n \"combinedMessagesQuota\": 250,\n \"membersQuota\": 2\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://sitegpt.ai/api/v0/w/brands/{brandId}/users")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"user@example.com\",\n \"chatbotsQuota\": 1,\n \"linksQuota\": 100,\n \"filesQuota\": 25,\n \"combinedMessagesQuota\": 250,\n \"membersQuota\": 2\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://sitegpt.ai/api/v0/w/brands/{brandId}/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"user@example.com\",\n \"chatbotsQuota\": 1,\n \"linksQuota\": 100,\n \"filesQuota\": 25,\n \"combinedMessagesQuota\": 250,\n \"membersQuota\": 2\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "message": "Added new whitelabel user of your brand successfully",
  "data": {
    "whitelabelUser": {
      "id": "332153612345906321",
      "brandId": "332110515123458123",
      "email": "user@example.com",
      "name": "",
      "profilePic": "",
      "chatbotsQuota": 1,
      "linksQuota": 10,
      "filesQuota": 5,
      "combinedMessagesQuota": 10,
      "membersQuota": 1,
      "createdAt": "2024-02-10T14:30:21.828601Z",
      "updatedAt": "2024-02-10T14:30:21.828601Z"
    }
  }
}
{
"success": false,
"message": "Failed to create the new whitelabel user",
"data": null,
"error": {
"code": "REQUEST_VALIDATION_FAILED",
"message": "Request body is not valid",
"details": [
{
"path": [
"chatbotsQuota"
],
"message": "Required"
}
]
}
}
{
"success": false,
"message": "Failed to add a new whitelabel user to the brand",
"data": null,
"error": {
"code": "API_KEY_NOT_VALID",
"message": "Authorization header does not contain valid API key",
"details": null
}
}
{
"success": false,
"message": "Failed to add a new whitelabel user to the brand",
"data": null,
"error": {
"code": "ADD_WHITELABEL_USER_FORBIDDEN",
"message": "You are not authorized to add a whitelabel user to the brand"
}
}
{
"success": false,
"message": "Failed to add a new whitelabel user to the brand",
"data": null,
"error": {
"code": "ADD_WHITELABEL_USER_BRAND_NOT_FOUND",
"message": "You don't have a whitelabel brand"
}
}
{
"success": false,
"message": "Failed to add a new whitelabel user to the brand",
"data": null,
"error": {
"code": "REQUEST_METHOD_NOT_ALLOWED",
"message": "PUT request method is not allowed"
}
}
{
"success": false,
"message": "Failed to add a new whitelabel user to the brand",
"data": null,
"error": {
"code": "ADD_WHITELABEL_USER_FAILED",
"message": "Some technical error has occurred !!"
}
}

Authorizations

Authorization
string
header
required

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

Path Parameters

brandId
string
required

Id of the whitelabel brand to which user belongs to

Body

application/json

Request body to add a new whitelabel user to your brand.

email
string<email>
required

Email of the user you want to add to your whitelabel brand

chatbotsQuota
integer
required

Chatbots quota to be assigned to the user

Required range: x >= 0

Links quota to be assigned to the user

Required range: x >= 0
filesQuota
integer
required

Files quota to be assigned to the user

Required range: x >= 0
combinedMessagesQuota
integer
required

Combined messages quota to be assigned to the user

Required range: x >= 0
membersQuota
integer
required

Members quota to be assigned to the user

Required range: x >= 0

Response

OK

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