Create Organization
curl --request POST \
--url https://eu-gcp-api.vg-stuff.com/v3/orgs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"email": "<string>",
"squarePhotoURL": "<string>",
"widgets": [
"<unknown>"
],
"widgetIDs": [
"<string>"
],
"dashboardUsername": "<string>",
"dashboardPassword": "<string>",
"canAccess": [
"<string>"
],
"allowedChannels": [
"<string>"
],
"allowedIntegrations": [
"<string>"
],
"clientTabOrder": [
"<string>"
],
"magicCode": "<string>",
"index": 123,
"isAdmin": true,
"usedSecret": "<string>",
"orgId": "<string>",
"isOrgAdmin": true,
"canDelegateChats": true,
"predefinedTags": [
"<string>"
],
"FB_PUSH_TOKEN": "<string>",
"handoff": {
"maxAssignees": 123
},
"lastEmailSentTS": 123,
"preferredLanguage": "<string>",
"internal": {
"hasChangedPassword": true
},
"lastInvitationTs": 123,
"cannedResponses": [
{
"key": "<string>",
"content": "<string>"
}
],
"stripeCustomerId": "<string>",
"signupSource": "<string>",
"allowCreateAgents": true,
"hideAdvancedSettings": true,
"onboardingState": {
"currentStep": 123,
"isCompleted": true,
"completedSteps": [
123
],
"personalInfo": {
"fullName": "<string>",
"companyName": "<string>",
"role": "<string>",
"industry": "<string>"
},
"preferences": {
"primaryUseCase": "<string>",
"communicationPreferences": [
"<string>"
],
"goals": [
"<string>"
]
},
"setupData": {
"selectedAgents": [
"<string>"
],
"customizations": "<unknown>"
}
},
"isNewSignup": true,
"teams": [
{
"ID": "<string>",
"key": "<string>",
"label": "<string>",
"description": "<string>",
"orgId": "<string>"
}
],
"adminIDs": [
"<string>"
],
"supportIDs": [
"<string>"
],
"canSelfEdit": true,
"lastModified": 123,
"defaultClientAccess": [
"<string>"
],
"defaultClientTabOrder": [
"<string>"
],
"convoTags": [
"<string>"
],
"enableHumanHandoff": true,
"settings": {
"disableClientAccess": true
}
}
'import requests
url = "https://eu-gcp-api.vg-stuff.com/v3/orgs"
payload = {
"name": "<string>",
"email": "<string>",
"squarePhotoURL": "<string>",
"widgets": ["<unknown>"],
"widgetIDs": ["<string>"],
"dashboardUsername": "<string>",
"dashboardPassword": "<string>",
"canAccess": ["<string>"],
"allowedChannels": ["<string>"],
"allowedIntegrations": ["<string>"],
"clientTabOrder": ["<string>"],
"magicCode": "<string>",
"index": 123,
"isAdmin": True,
"usedSecret": "<string>",
"orgId": "<string>",
"isOrgAdmin": True,
"canDelegateChats": True,
"predefinedTags": ["<string>"],
"FB_PUSH_TOKEN": "<string>",
"handoff": { "maxAssignees": 123 },
"lastEmailSentTS": 123,
"preferredLanguage": "<string>",
"internal": { "hasChangedPassword": True },
"lastInvitationTs": 123,
"cannedResponses": [
{
"key": "<string>",
"content": "<string>"
}
],
"stripeCustomerId": "<string>",
"signupSource": "<string>",
"allowCreateAgents": True,
"hideAdvancedSettings": True,
"onboardingState": {
"currentStep": 123,
"isCompleted": True,
"completedSteps": [123],
"personalInfo": {
"fullName": "<string>",
"companyName": "<string>",
"role": "<string>",
"industry": "<string>"
},
"preferences": {
"primaryUseCase": "<string>",
"communicationPreferences": ["<string>"],
"goals": ["<string>"]
},
"setupData": {
"selectedAgents": ["<string>"],
"customizations": "<unknown>"
}
},
"isNewSignup": True,
"teams": [
{
"ID": "<string>",
"key": "<string>",
"label": "<string>",
"description": "<string>",
"orgId": "<string>"
}
],
"adminIDs": ["<string>"],
"supportIDs": ["<string>"],
"canSelfEdit": True,
"lastModified": 123,
"defaultClientAccess": ["<string>"],
"defaultClientTabOrder": ["<string>"],
"convoTags": ["<string>"],
"enableHumanHandoff": True,
"settings": { "disableClientAccess": True }
}
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({
name: '<string>',
email: '<string>',
squarePhotoURL: '<string>',
widgets: ['<unknown>'],
widgetIDs: ['<string>'],
dashboardUsername: '<string>',
dashboardPassword: '<string>',
canAccess: ['<string>'],
allowedChannels: ['<string>'],
allowedIntegrations: ['<string>'],
clientTabOrder: ['<string>'],
magicCode: '<string>',
index: 123,
isAdmin: true,
usedSecret: '<string>',
orgId: '<string>',
isOrgAdmin: true,
canDelegateChats: true,
predefinedTags: ['<string>'],
FB_PUSH_TOKEN: '<string>',
handoff: {maxAssignees: 123},
lastEmailSentTS: 123,
preferredLanguage: '<string>',
internal: {hasChangedPassword: true},
lastInvitationTs: 123,
cannedResponses: [{key: '<string>', content: '<string>'}],
stripeCustomerId: '<string>',
signupSource: '<string>',
allowCreateAgents: true,
hideAdvancedSettings: true,
onboardingState: {
currentStep: 123,
isCompleted: true,
completedSteps: [123],
personalInfo: {
fullName: '<string>',
companyName: '<string>',
role: '<string>',
industry: '<string>'
},
preferences: {
primaryUseCase: '<string>',
communicationPreferences: ['<string>'],
goals: ['<string>']
},
setupData: {selectedAgents: ['<string>'], customizations: '<unknown>'}
},
isNewSignup: true,
teams: [
{
ID: '<string>',
key: '<string>',
label: '<string>',
description: '<string>',
orgId: '<string>'
}
],
adminIDs: ['<string>'],
supportIDs: ['<string>'],
canSelfEdit: true,
lastModified: 123,
defaultClientAccess: ['<string>'],
defaultClientTabOrder: ['<string>'],
convoTags: ['<string>'],
enableHumanHandoff: true,
settings: {disableClientAccess: true}
})
};
fetch('https://eu-gcp-api.vg-stuff.com/v3/orgs', 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://eu-gcp-api.vg-stuff.com/v3/orgs",
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([
'name' => '<string>',
'email' => '<string>',
'squarePhotoURL' => '<string>',
'widgets' => [
'<unknown>'
],
'widgetIDs' => [
'<string>'
],
'dashboardUsername' => '<string>',
'dashboardPassword' => '<string>',
'canAccess' => [
'<string>'
],
'allowedChannels' => [
'<string>'
],
'allowedIntegrations' => [
'<string>'
],
'clientTabOrder' => [
'<string>'
],
'magicCode' => '<string>',
'index' => 123,
'isAdmin' => true,
'usedSecret' => '<string>',
'orgId' => '<string>',
'isOrgAdmin' => true,
'canDelegateChats' => true,
'predefinedTags' => [
'<string>'
],
'FB_PUSH_TOKEN' => '<string>',
'handoff' => [
'maxAssignees' => 123
],
'lastEmailSentTS' => 123,
'preferredLanguage' => '<string>',
'internal' => [
'hasChangedPassword' => true
],
'lastInvitationTs' => 123,
'cannedResponses' => [
[
'key' => '<string>',
'content' => '<string>'
]
],
'stripeCustomerId' => '<string>',
'signupSource' => '<string>',
'allowCreateAgents' => true,
'hideAdvancedSettings' => true,
'onboardingState' => [
'currentStep' => 123,
'isCompleted' => true,
'completedSteps' => [
123
],
'personalInfo' => [
'fullName' => '<string>',
'companyName' => '<string>',
'role' => '<string>',
'industry' => '<string>'
],
'preferences' => [
'primaryUseCase' => '<string>',
'communicationPreferences' => [
'<string>'
],
'goals' => [
'<string>'
]
],
'setupData' => [
'selectedAgents' => [
'<string>'
],
'customizations' => '<unknown>'
]
],
'isNewSignup' => true,
'teams' => [
[
'ID' => '<string>',
'key' => '<string>',
'label' => '<string>',
'description' => '<string>',
'orgId' => '<string>'
]
],
'adminIDs' => [
'<string>'
],
'supportIDs' => [
'<string>'
],
'canSelfEdit' => true,
'lastModified' => 123,
'defaultClientAccess' => [
'<string>'
],
'defaultClientTabOrder' => [
'<string>'
],
'convoTags' => [
'<string>'
],
'enableHumanHandoff' => true,
'settings' => [
'disableClientAccess' => true
]
]),
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://eu-gcp-api.vg-stuff.com/v3/orgs"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"squarePhotoURL\": \"<string>\",\n \"widgets\": [\n \"<unknown>\"\n ],\n \"widgetIDs\": [\n \"<string>\"\n ],\n \"dashboardUsername\": \"<string>\",\n \"dashboardPassword\": \"<string>\",\n \"canAccess\": [\n \"<string>\"\n ],\n \"allowedChannels\": [\n \"<string>\"\n ],\n \"allowedIntegrations\": [\n \"<string>\"\n ],\n \"clientTabOrder\": [\n \"<string>\"\n ],\n \"magicCode\": \"<string>\",\n \"index\": 123,\n \"isAdmin\": true,\n \"usedSecret\": \"<string>\",\n \"orgId\": \"<string>\",\n \"isOrgAdmin\": true,\n \"canDelegateChats\": true,\n \"predefinedTags\": [\n \"<string>\"\n ],\n \"FB_PUSH_TOKEN\": \"<string>\",\n \"handoff\": {\n \"maxAssignees\": 123\n },\n \"lastEmailSentTS\": 123,\n \"preferredLanguage\": \"<string>\",\n \"internal\": {\n \"hasChangedPassword\": true\n },\n \"lastInvitationTs\": 123,\n \"cannedResponses\": [\n {\n \"key\": \"<string>\",\n \"content\": \"<string>\"\n }\n ],\n \"stripeCustomerId\": \"<string>\",\n \"signupSource\": \"<string>\",\n \"allowCreateAgents\": true,\n \"hideAdvancedSettings\": true,\n \"onboardingState\": {\n \"currentStep\": 123,\n \"isCompleted\": true,\n \"completedSteps\": [\n 123\n ],\n \"personalInfo\": {\n \"fullName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"role\": \"<string>\",\n \"industry\": \"<string>\"\n },\n \"preferences\": {\n \"primaryUseCase\": \"<string>\",\n \"communicationPreferences\": [\n \"<string>\"\n ],\n \"goals\": [\n \"<string>\"\n ]\n },\n \"setupData\": {\n \"selectedAgents\": [\n \"<string>\"\n ],\n \"customizations\": \"<unknown>\"\n }\n },\n \"isNewSignup\": true,\n \"teams\": [\n {\n \"ID\": \"<string>\",\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"orgId\": \"<string>\"\n }\n ],\n \"adminIDs\": [\n \"<string>\"\n ],\n \"supportIDs\": [\n \"<string>\"\n ],\n \"canSelfEdit\": true,\n \"lastModified\": 123,\n \"defaultClientAccess\": [\n \"<string>\"\n ],\n \"defaultClientTabOrder\": [\n \"<string>\"\n ],\n \"convoTags\": [\n \"<string>\"\n ],\n \"enableHumanHandoff\": true,\n \"settings\": {\n \"disableClientAccess\": true\n }\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://eu-gcp-api.vg-stuff.com/v3/orgs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"squarePhotoURL\": \"<string>\",\n \"widgets\": [\n \"<unknown>\"\n ],\n \"widgetIDs\": [\n \"<string>\"\n ],\n \"dashboardUsername\": \"<string>\",\n \"dashboardPassword\": \"<string>\",\n \"canAccess\": [\n \"<string>\"\n ],\n \"allowedChannels\": [\n \"<string>\"\n ],\n \"allowedIntegrations\": [\n \"<string>\"\n ],\n \"clientTabOrder\": [\n \"<string>\"\n ],\n \"magicCode\": \"<string>\",\n \"index\": 123,\n \"isAdmin\": true,\n \"usedSecret\": \"<string>\",\n \"orgId\": \"<string>\",\n \"isOrgAdmin\": true,\n \"canDelegateChats\": true,\n \"predefinedTags\": [\n \"<string>\"\n ],\n \"FB_PUSH_TOKEN\": \"<string>\",\n \"handoff\": {\n \"maxAssignees\": 123\n },\n \"lastEmailSentTS\": 123,\n \"preferredLanguage\": \"<string>\",\n \"internal\": {\n \"hasChangedPassword\": true\n },\n \"lastInvitationTs\": 123,\n \"cannedResponses\": [\n {\n \"key\": \"<string>\",\n \"content\": \"<string>\"\n }\n ],\n \"stripeCustomerId\": \"<string>\",\n \"signupSource\": \"<string>\",\n \"allowCreateAgents\": true,\n \"hideAdvancedSettings\": true,\n \"onboardingState\": {\n \"currentStep\": 123,\n \"isCompleted\": true,\n \"completedSteps\": [\n 123\n ],\n \"personalInfo\": {\n \"fullName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"role\": \"<string>\",\n \"industry\": \"<string>\"\n },\n \"preferences\": {\n \"primaryUseCase\": \"<string>\",\n \"communicationPreferences\": [\n \"<string>\"\n ],\n \"goals\": [\n \"<string>\"\n ]\n },\n \"setupData\": {\n \"selectedAgents\": [\n \"<string>\"\n ],\n \"customizations\": \"<unknown>\"\n }\n },\n \"isNewSignup\": true,\n \"teams\": [\n {\n \"ID\": \"<string>\",\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"orgId\": \"<string>\"\n }\n ],\n \"adminIDs\": [\n \"<string>\"\n ],\n \"supportIDs\": [\n \"<string>\"\n ],\n \"canSelfEdit\": true,\n \"lastModified\": 123,\n \"defaultClientAccess\": [\n \"<string>\"\n ],\n \"defaultClientTabOrder\": [\n \"<string>\"\n ],\n \"convoTags\": [\n \"<string>\"\n ],\n \"enableHumanHandoff\": true,\n \"settings\": {\n \"disableClientAccess\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://eu-gcp-api.vg-stuff.com/v3/orgs")
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 \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"squarePhotoURL\": \"<string>\",\n \"widgets\": [\n \"<unknown>\"\n ],\n \"widgetIDs\": [\n \"<string>\"\n ],\n \"dashboardUsername\": \"<string>\",\n \"dashboardPassword\": \"<string>\",\n \"canAccess\": [\n \"<string>\"\n ],\n \"allowedChannels\": [\n \"<string>\"\n ],\n \"allowedIntegrations\": [\n \"<string>\"\n ],\n \"clientTabOrder\": [\n \"<string>\"\n ],\n \"magicCode\": \"<string>\",\n \"index\": 123,\n \"isAdmin\": true,\n \"usedSecret\": \"<string>\",\n \"orgId\": \"<string>\",\n \"isOrgAdmin\": true,\n \"canDelegateChats\": true,\n \"predefinedTags\": [\n \"<string>\"\n ],\n \"FB_PUSH_TOKEN\": \"<string>\",\n \"handoff\": {\n \"maxAssignees\": 123\n },\n \"lastEmailSentTS\": 123,\n \"preferredLanguage\": \"<string>\",\n \"internal\": {\n \"hasChangedPassword\": true\n },\n \"lastInvitationTs\": 123,\n \"cannedResponses\": [\n {\n \"key\": \"<string>\",\n \"content\": \"<string>\"\n }\n ],\n \"stripeCustomerId\": \"<string>\",\n \"signupSource\": \"<string>\",\n \"allowCreateAgents\": true,\n \"hideAdvancedSettings\": true,\n \"onboardingState\": {\n \"currentStep\": 123,\n \"isCompleted\": true,\n \"completedSteps\": [\n 123\n ],\n \"personalInfo\": {\n \"fullName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"role\": \"<string>\",\n \"industry\": \"<string>\"\n },\n \"preferences\": {\n \"primaryUseCase\": \"<string>\",\n \"communicationPreferences\": [\n \"<string>\"\n ],\n \"goals\": [\n \"<string>\"\n ]\n },\n \"setupData\": {\n \"selectedAgents\": [\n \"<string>\"\n ],\n \"customizations\": \"<unknown>\"\n }\n },\n \"isNewSignup\": true,\n \"teams\": [\n {\n \"ID\": \"<string>\",\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"orgId\": \"<string>\"\n }\n ],\n \"adminIDs\": [\n \"<string>\"\n ],\n \"supportIDs\": [\n \"<string>\"\n ],\n \"canSelfEdit\": true,\n \"lastModified\": 123,\n \"defaultClientAccess\": [\n \"<string>\"\n ],\n \"defaultClientTabOrder\": [\n \"<string>\"\n ],\n \"convoTags\": [\n \"<string>\"\n ],\n \"enableHumanHandoff\": true,\n \"settings\": {\n \"disableClientAccess\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"orgId": "<string>",
"data": {
"ID": "<string>",
"firebaseUid": "<string>",
"agencyId": "<string>",
"userId": "<string>",
"ownerID": "<string>",
"name": "<string>",
"email": "<string>",
"squarePhotoURL": "<string>",
"widgets": [
"<unknown>"
],
"widgetIDs": [
"<string>"
],
"dashboardUsername": "<string>",
"dashboardPassword": "<string>",
"ts": 123,
"canAccess": [
"<string>"
],
"allowedChannels": [
"<string>"
],
"allowedIntegrations": [
"<string>"
],
"clientTabOrder": [
"<string>"
],
"magicCode": "<string>",
"index": 123,
"isAdmin": true,
"usedSecret": "<string>",
"orgId": "<string>",
"type": "client",
"isOrgAdmin": true,
"canDelegateChats": true,
"status": "online",
"predefinedTags": [
"<string>"
],
"FB_PUSH_TOKEN": "<string>",
"notificationsSettings": {
"notifyThrough": "email",
"notifyIf": "all",
"emailNotifyOnNewLead": true
},
"handoff": {
"maxAssignees": 123
},
"lastEmailSentTS": 123,
"preferredLanguage": "<string>",
"internal": {
"hasChangedPassword": true
},
"lastInvitationTs": 123,
"cannedResponses": [
{
"key": "<string>",
"content": "<string>"
}
],
"stripeCustomerId": "<string>",
"signupSource": "<string>",
"allowCreateAgents": true,
"hideAdvancedSettings": true,
"onboardingState": {
"currentStep": 123,
"isCompleted": true,
"completedSteps": [
123
],
"personalInfo": {
"fullName": "<string>",
"companyName": "<string>",
"role": "<string>",
"industry": "<string>"
},
"preferences": {
"primaryUseCase": "<string>",
"communicationPreferences": [
"<string>"
],
"goals": [
"<string>"
]
},
"setupData": {
"selectedAgents": [
"<string>"
],
"customizations": "<unknown>"
}
},
"isNewSignup": true,
"teams": [
{
"ID": "<string>",
"key": "<string>",
"label": "<string>",
"description": "<string>",
"orgId": "<string>"
}
],
"adminIDs": [
"<string>"
],
"supportIDs": [
"<string>"
],
"canSelfEdit": true,
"workspaceId": "<string>",
"lastModified": 123,
"defaultClientAccess": [
"<string>"
],
"defaultClientTabOrder": [
"<string>"
],
"convoTags": [
"<string>"
],
"enableHumanHandoff": true,
"dashboardLayout": "vertical",
"settings": {
"disableClientAccess": true
}
}
}{
"message": "<string>",
"code": "<string>",
"issues": [
{
"message": "<string>"
}
]
}Orgs
Create Organization
Create a new organization under the authenticated workspace
POST
/
orgs
Create Organization
curl --request POST \
--url https://eu-gcp-api.vg-stuff.com/v3/orgs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"email": "<string>",
"squarePhotoURL": "<string>",
"widgets": [
"<unknown>"
],
"widgetIDs": [
"<string>"
],
"dashboardUsername": "<string>",
"dashboardPassword": "<string>",
"canAccess": [
"<string>"
],
"allowedChannels": [
"<string>"
],
"allowedIntegrations": [
"<string>"
],
"clientTabOrder": [
"<string>"
],
"magicCode": "<string>",
"index": 123,
"isAdmin": true,
"usedSecret": "<string>",
"orgId": "<string>",
"isOrgAdmin": true,
"canDelegateChats": true,
"predefinedTags": [
"<string>"
],
"FB_PUSH_TOKEN": "<string>",
"handoff": {
"maxAssignees": 123
},
"lastEmailSentTS": 123,
"preferredLanguage": "<string>",
"internal": {
"hasChangedPassword": true
},
"lastInvitationTs": 123,
"cannedResponses": [
{
"key": "<string>",
"content": "<string>"
}
],
"stripeCustomerId": "<string>",
"signupSource": "<string>",
"allowCreateAgents": true,
"hideAdvancedSettings": true,
"onboardingState": {
"currentStep": 123,
"isCompleted": true,
"completedSteps": [
123
],
"personalInfo": {
"fullName": "<string>",
"companyName": "<string>",
"role": "<string>",
"industry": "<string>"
},
"preferences": {
"primaryUseCase": "<string>",
"communicationPreferences": [
"<string>"
],
"goals": [
"<string>"
]
},
"setupData": {
"selectedAgents": [
"<string>"
],
"customizations": "<unknown>"
}
},
"isNewSignup": true,
"teams": [
{
"ID": "<string>",
"key": "<string>",
"label": "<string>",
"description": "<string>",
"orgId": "<string>"
}
],
"adminIDs": [
"<string>"
],
"supportIDs": [
"<string>"
],
"canSelfEdit": true,
"lastModified": 123,
"defaultClientAccess": [
"<string>"
],
"defaultClientTabOrder": [
"<string>"
],
"convoTags": [
"<string>"
],
"enableHumanHandoff": true,
"settings": {
"disableClientAccess": true
}
}
'import requests
url = "https://eu-gcp-api.vg-stuff.com/v3/orgs"
payload = {
"name": "<string>",
"email": "<string>",
"squarePhotoURL": "<string>",
"widgets": ["<unknown>"],
"widgetIDs": ["<string>"],
"dashboardUsername": "<string>",
"dashboardPassword": "<string>",
"canAccess": ["<string>"],
"allowedChannels": ["<string>"],
"allowedIntegrations": ["<string>"],
"clientTabOrder": ["<string>"],
"magicCode": "<string>",
"index": 123,
"isAdmin": True,
"usedSecret": "<string>",
"orgId": "<string>",
"isOrgAdmin": True,
"canDelegateChats": True,
"predefinedTags": ["<string>"],
"FB_PUSH_TOKEN": "<string>",
"handoff": { "maxAssignees": 123 },
"lastEmailSentTS": 123,
"preferredLanguage": "<string>",
"internal": { "hasChangedPassword": True },
"lastInvitationTs": 123,
"cannedResponses": [
{
"key": "<string>",
"content": "<string>"
}
],
"stripeCustomerId": "<string>",
"signupSource": "<string>",
"allowCreateAgents": True,
"hideAdvancedSettings": True,
"onboardingState": {
"currentStep": 123,
"isCompleted": True,
"completedSteps": [123],
"personalInfo": {
"fullName": "<string>",
"companyName": "<string>",
"role": "<string>",
"industry": "<string>"
},
"preferences": {
"primaryUseCase": "<string>",
"communicationPreferences": ["<string>"],
"goals": ["<string>"]
},
"setupData": {
"selectedAgents": ["<string>"],
"customizations": "<unknown>"
}
},
"isNewSignup": True,
"teams": [
{
"ID": "<string>",
"key": "<string>",
"label": "<string>",
"description": "<string>",
"orgId": "<string>"
}
],
"adminIDs": ["<string>"],
"supportIDs": ["<string>"],
"canSelfEdit": True,
"lastModified": 123,
"defaultClientAccess": ["<string>"],
"defaultClientTabOrder": ["<string>"],
"convoTags": ["<string>"],
"enableHumanHandoff": True,
"settings": { "disableClientAccess": True }
}
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({
name: '<string>',
email: '<string>',
squarePhotoURL: '<string>',
widgets: ['<unknown>'],
widgetIDs: ['<string>'],
dashboardUsername: '<string>',
dashboardPassword: '<string>',
canAccess: ['<string>'],
allowedChannels: ['<string>'],
allowedIntegrations: ['<string>'],
clientTabOrder: ['<string>'],
magicCode: '<string>',
index: 123,
isAdmin: true,
usedSecret: '<string>',
orgId: '<string>',
isOrgAdmin: true,
canDelegateChats: true,
predefinedTags: ['<string>'],
FB_PUSH_TOKEN: '<string>',
handoff: {maxAssignees: 123},
lastEmailSentTS: 123,
preferredLanguage: '<string>',
internal: {hasChangedPassword: true},
lastInvitationTs: 123,
cannedResponses: [{key: '<string>', content: '<string>'}],
stripeCustomerId: '<string>',
signupSource: '<string>',
allowCreateAgents: true,
hideAdvancedSettings: true,
onboardingState: {
currentStep: 123,
isCompleted: true,
completedSteps: [123],
personalInfo: {
fullName: '<string>',
companyName: '<string>',
role: '<string>',
industry: '<string>'
},
preferences: {
primaryUseCase: '<string>',
communicationPreferences: ['<string>'],
goals: ['<string>']
},
setupData: {selectedAgents: ['<string>'], customizations: '<unknown>'}
},
isNewSignup: true,
teams: [
{
ID: '<string>',
key: '<string>',
label: '<string>',
description: '<string>',
orgId: '<string>'
}
],
adminIDs: ['<string>'],
supportIDs: ['<string>'],
canSelfEdit: true,
lastModified: 123,
defaultClientAccess: ['<string>'],
defaultClientTabOrder: ['<string>'],
convoTags: ['<string>'],
enableHumanHandoff: true,
settings: {disableClientAccess: true}
})
};
fetch('https://eu-gcp-api.vg-stuff.com/v3/orgs', 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://eu-gcp-api.vg-stuff.com/v3/orgs",
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([
'name' => '<string>',
'email' => '<string>',
'squarePhotoURL' => '<string>',
'widgets' => [
'<unknown>'
],
'widgetIDs' => [
'<string>'
],
'dashboardUsername' => '<string>',
'dashboardPassword' => '<string>',
'canAccess' => [
'<string>'
],
'allowedChannels' => [
'<string>'
],
'allowedIntegrations' => [
'<string>'
],
'clientTabOrder' => [
'<string>'
],
'magicCode' => '<string>',
'index' => 123,
'isAdmin' => true,
'usedSecret' => '<string>',
'orgId' => '<string>',
'isOrgAdmin' => true,
'canDelegateChats' => true,
'predefinedTags' => [
'<string>'
],
'FB_PUSH_TOKEN' => '<string>',
'handoff' => [
'maxAssignees' => 123
],
'lastEmailSentTS' => 123,
'preferredLanguage' => '<string>',
'internal' => [
'hasChangedPassword' => true
],
'lastInvitationTs' => 123,
'cannedResponses' => [
[
'key' => '<string>',
'content' => '<string>'
]
],
'stripeCustomerId' => '<string>',
'signupSource' => '<string>',
'allowCreateAgents' => true,
'hideAdvancedSettings' => true,
'onboardingState' => [
'currentStep' => 123,
'isCompleted' => true,
'completedSteps' => [
123
],
'personalInfo' => [
'fullName' => '<string>',
'companyName' => '<string>',
'role' => '<string>',
'industry' => '<string>'
],
'preferences' => [
'primaryUseCase' => '<string>',
'communicationPreferences' => [
'<string>'
],
'goals' => [
'<string>'
]
],
'setupData' => [
'selectedAgents' => [
'<string>'
],
'customizations' => '<unknown>'
]
],
'isNewSignup' => true,
'teams' => [
[
'ID' => '<string>',
'key' => '<string>',
'label' => '<string>',
'description' => '<string>',
'orgId' => '<string>'
]
],
'adminIDs' => [
'<string>'
],
'supportIDs' => [
'<string>'
],
'canSelfEdit' => true,
'lastModified' => 123,
'defaultClientAccess' => [
'<string>'
],
'defaultClientTabOrder' => [
'<string>'
],
'convoTags' => [
'<string>'
],
'enableHumanHandoff' => true,
'settings' => [
'disableClientAccess' => true
]
]),
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://eu-gcp-api.vg-stuff.com/v3/orgs"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"squarePhotoURL\": \"<string>\",\n \"widgets\": [\n \"<unknown>\"\n ],\n \"widgetIDs\": [\n \"<string>\"\n ],\n \"dashboardUsername\": \"<string>\",\n \"dashboardPassword\": \"<string>\",\n \"canAccess\": [\n \"<string>\"\n ],\n \"allowedChannels\": [\n \"<string>\"\n ],\n \"allowedIntegrations\": [\n \"<string>\"\n ],\n \"clientTabOrder\": [\n \"<string>\"\n ],\n \"magicCode\": \"<string>\",\n \"index\": 123,\n \"isAdmin\": true,\n \"usedSecret\": \"<string>\",\n \"orgId\": \"<string>\",\n \"isOrgAdmin\": true,\n \"canDelegateChats\": true,\n \"predefinedTags\": [\n \"<string>\"\n ],\n \"FB_PUSH_TOKEN\": \"<string>\",\n \"handoff\": {\n \"maxAssignees\": 123\n },\n \"lastEmailSentTS\": 123,\n \"preferredLanguage\": \"<string>\",\n \"internal\": {\n \"hasChangedPassword\": true\n },\n \"lastInvitationTs\": 123,\n \"cannedResponses\": [\n {\n \"key\": \"<string>\",\n \"content\": \"<string>\"\n }\n ],\n \"stripeCustomerId\": \"<string>\",\n \"signupSource\": \"<string>\",\n \"allowCreateAgents\": true,\n \"hideAdvancedSettings\": true,\n \"onboardingState\": {\n \"currentStep\": 123,\n \"isCompleted\": true,\n \"completedSteps\": [\n 123\n ],\n \"personalInfo\": {\n \"fullName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"role\": \"<string>\",\n \"industry\": \"<string>\"\n },\n \"preferences\": {\n \"primaryUseCase\": \"<string>\",\n \"communicationPreferences\": [\n \"<string>\"\n ],\n \"goals\": [\n \"<string>\"\n ]\n },\n \"setupData\": {\n \"selectedAgents\": [\n \"<string>\"\n ],\n \"customizations\": \"<unknown>\"\n }\n },\n \"isNewSignup\": true,\n \"teams\": [\n {\n \"ID\": \"<string>\",\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"orgId\": \"<string>\"\n }\n ],\n \"adminIDs\": [\n \"<string>\"\n ],\n \"supportIDs\": [\n \"<string>\"\n ],\n \"canSelfEdit\": true,\n \"lastModified\": 123,\n \"defaultClientAccess\": [\n \"<string>\"\n ],\n \"defaultClientTabOrder\": [\n \"<string>\"\n ],\n \"convoTags\": [\n \"<string>\"\n ],\n \"enableHumanHandoff\": true,\n \"settings\": {\n \"disableClientAccess\": true\n }\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://eu-gcp-api.vg-stuff.com/v3/orgs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"squarePhotoURL\": \"<string>\",\n \"widgets\": [\n \"<unknown>\"\n ],\n \"widgetIDs\": [\n \"<string>\"\n ],\n \"dashboardUsername\": \"<string>\",\n \"dashboardPassword\": \"<string>\",\n \"canAccess\": [\n \"<string>\"\n ],\n \"allowedChannels\": [\n \"<string>\"\n ],\n \"allowedIntegrations\": [\n \"<string>\"\n ],\n \"clientTabOrder\": [\n \"<string>\"\n ],\n \"magicCode\": \"<string>\",\n \"index\": 123,\n \"isAdmin\": true,\n \"usedSecret\": \"<string>\",\n \"orgId\": \"<string>\",\n \"isOrgAdmin\": true,\n \"canDelegateChats\": true,\n \"predefinedTags\": [\n \"<string>\"\n ],\n \"FB_PUSH_TOKEN\": \"<string>\",\n \"handoff\": {\n \"maxAssignees\": 123\n },\n \"lastEmailSentTS\": 123,\n \"preferredLanguage\": \"<string>\",\n \"internal\": {\n \"hasChangedPassword\": true\n },\n \"lastInvitationTs\": 123,\n \"cannedResponses\": [\n {\n \"key\": \"<string>\",\n \"content\": \"<string>\"\n }\n ],\n \"stripeCustomerId\": \"<string>\",\n \"signupSource\": \"<string>\",\n \"allowCreateAgents\": true,\n \"hideAdvancedSettings\": true,\n \"onboardingState\": {\n \"currentStep\": 123,\n \"isCompleted\": true,\n \"completedSteps\": [\n 123\n ],\n \"personalInfo\": {\n \"fullName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"role\": \"<string>\",\n \"industry\": \"<string>\"\n },\n \"preferences\": {\n \"primaryUseCase\": \"<string>\",\n \"communicationPreferences\": [\n \"<string>\"\n ],\n \"goals\": [\n \"<string>\"\n ]\n },\n \"setupData\": {\n \"selectedAgents\": [\n \"<string>\"\n ],\n \"customizations\": \"<unknown>\"\n }\n },\n \"isNewSignup\": true,\n \"teams\": [\n {\n \"ID\": \"<string>\",\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"orgId\": \"<string>\"\n }\n ],\n \"adminIDs\": [\n \"<string>\"\n ],\n \"supportIDs\": [\n \"<string>\"\n ],\n \"canSelfEdit\": true,\n \"lastModified\": 123,\n \"defaultClientAccess\": [\n \"<string>\"\n ],\n \"defaultClientTabOrder\": [\n \"<string>\"\n ],\n \"convoTags\": [\n \"<string>\"\n ],\n \"enableHumanHandoff\": true,\n \"settings\": {\n \"disableClientAccess\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://eu-gcp-api.vg-stuff.com/v3/orgs")
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 \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"squarePhotoURL\": \"<string>\",\n \"widgets\": [\n \"<unknown>\"\n ],\n \"widgetIDs\": [\n \"<string>\"\n ],\n \"dashboardUsername\": \"<string>\",\n \"dashboardPassword\": \"<string>\",\n \"canAccess\": [\n \"<string>\"\n ],\n \"allowedChannels\": [\n \"<string>\"\n ],\n \"allowedIntegrations\": [\n \"<string>\"\n ],\n \"clientTabOrder\": [\n \"<string>\"\n ],\n \"magicCode\": \"<string>\",\n \"index\": 123,\n \"isAdmin\": true,\n \"usedSecret\": \"<string>\",\n \"orgId\": \"<string>\",\n \"isOrgAdmin\": true,\n \"canDelegateChats\": true,\n \"predefinedTags\": [\n \"<string>\"\n ],\n \"FB_PUSH_TOKEN\": \"<string>\",\n \"handoff\": {\n \"maxAssignees\": 123\n },\n \"lastEmailSentTS\": 123,\n \"preferredLanguage\": \"<string>\",\n \"internal\": {\n \"hasChangedPassword\": true\n },\n \"lastInvitationTs\": 123,\n \"cannedResponses\": [\n {\n \"key\": \"<string>\",\n \"content\": \"<string>\"\n }\n ],\n \"stripeCustomerId\": \"<string>\",\n \"signupSource\": \"<string>\",\n \"allowCreateAgents\": true,\n \"hideAdvancedSettings\": true,\n \"onboardingState\": {\n \"currentStep\": 123,\n \"isCompleted\": true,\n \"completedSteps\": [\n 123\n ],\n \"personalInfo\": {\n \"fullName\": \"<string>\",\n \"companyName\": \"<string>\",\n \"role\": \"<string>\",\n \"industry\": \"<string>\"\n },\n \"preferences\": {\n \"primaryUseCase\": \"<string>\",\n \"communicationPreferences\": [\n \"<string>\"\n ],\n \"goals\": [\n \"<string>\"\n ]\n },\n \"setupData\": {\n \"selectedAgents\": [\n \"<string>\"\n ],\n \"customizations\": \"<unknown>\"\n }\n },\n \"isNewSignup\": true,\n \"teams\": [\n {\n \"ID\": \"<string>\",\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"orgId\": \"<string>\"\n }\n ],\n \"adminIDs\": [\n \"<string>\"\n ],\n \"supportIDs\": [\n \"<string>\"\n ],\n \"canSelfEdit\": true,\n \"lastModified\": 123,\n \"defaultClientAccess\": [\n \"<string>\"\n ],\n \"defaultClientTabOrder\": [\n \"<string>\"\n ],\n \"convoTags\": [\n \"<string>\"\n ],\n \"enableHumanHandoff\": true,\n \"settings\": {\n \"disableClientAccess\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"orgId": "<string>",
"data": {
"ID": "<string>",
"firebaseUid": "<string>",
"agencyId": "<string>",
"userId": "<string>",
"ownerID": "<string>",
"name": "<string>",
"email": "<string>",
"squarePhotoURL": "<string>",
"widgets": [
"<unknown>"
],
"widgetIDs": [
"<string>"
],
"dashboardUsername": "<string>",
"dashboardPassword": "<string>",
"ts": 123,
"canAccess": [
"<string>"
],
"allowedChannels": [
"<string>"
],
"allowedIntegrations": [
"<string>"
],
"clientTabOrder": [
"<string>"
],
"magicCode": "<string>",
"index": 123,
"isAdmin": true,
"usedSecret": "<string>",
"orgId": "<string>",
"type": "client",
"isOrgAdmin": true,
"canDelegateChats": true,
"status": "online",
"predefinedTags": [
"<string>"
],
"FB_PUSH_TOKEN": "<string>",
"notificationsSettings": {
"notifyThrough": "email",
"notifyIf": "all",
"emailNotifyOnNewLead": true
},
"handoff": {
"maxAssignees": 123
},
"lastEmailSentTS": 123,
"preferredLanguage": "<string>",
"internal": {
"hasChangedPassword": true
},
"lastInvitationTs": 123,
"cannedResponses": [
{
"key": "<string>",
"content": "<string>"
}
],
"stripeCustomerId": "<string>",
"signupSource": "<string>",
"allowCreateAgents": true,
"hideAdvancedSettings": true,
"onboardingState": {
"currentStep": 123,
"isCompleted": true,
"completedSteps": [
123
],
"personalInfo": {
"fullName": "<string>",
"companyName": "<string>",
"role": "<string>",
"industry": "<string>"
},
"preferences": {
"primaryUseCase": "<string>",
"communicationPreferences": [
"<string>"
],
"goals": [
"<string>"
]
},
"setupData": {
"selectedAgents": [
"<string>"
],
"customizations": "<unknown>"
}
},
"isNewSignup": true,
"teams": [
{
"ID": "<string>",
"key": "<string>",
"label": "<string>",
"description": "<string>",
"orgId": "<string>"
}
],
"adminIDs": [
"<string>"
],
"supportIDs": [
"<string>"
],
"canSelfEdit": true,
"workspaceId": "<string>",
"lastModified": 123,
"defaultClientAccess": [
"<string>"
],
"defaultClientTabOrder": [
"<string>"
],
"convoTags": [
"<string>"
],
"enableHumanHandoff": true,
"dashboardLayout": "vertical",
"settings": {
"disableClientAccess": true
}
}
}{
"message": "<string>",
"code": "<string>",
"issues": [
{
"message": "<string>"
}
]
}Creates an organization (the “client” card in the dashboard Clients page). Returns
orgId plus the full org document in data.Example Request
Minimal:{
"name": "Acme Corp",
"email": "ops@acme.example",
"squarePhotoURL": "https://example.com/logo.png"
}
{
"name": "Acme Corp",
"email": "ops@acme.example",
"squarePhotoURL": "https://example.com/logo.png",
"preferredLanguage": "en",
"widgetIDs": ["agent_abc123"],
"canAccess": ["/home", "/convos", "/leads"],
"settings": {
"disableClientAccess": false
}
}
ID, userId, agencyId, ts, type: "org"). Use PATCH /orgs/{orgId} to change more fields later.
After creating an org, assign agents with
POST /orgs/{orgId}/agents/{agentId} and add users with POST /clients. Fetch the full document anytime with GET /orgs/{orgId}.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Display name for the organization (Clients page card).
Minimum string length:
1The email of the client which will be used by them to sign in also can be used in your whitelabel dashboard to autofill by appending ?email=test@gmail.
Photo URL of the client, will show on their dashboard.
The widgets of the client (USED BY SYTEM ONLY)
The IDs of agents assigned to this client.
The username of the dashboard (DEPRACATED NOT USED)
The sign in dashboard for the client, used along the email to sign in to the whitelabel dashboard append ?password=123 to autofill the fields on the dashboard login.
The tabs hrefs the user can access, example ['/home', '/convos', '/leads', '/kb', '/analytics', '/theme', '/settings', '/prompt']
Channels this client can use on the channels page. Use ["all"] or omit for every channel.
Integrations this client can use on the integrations page. Use ["all"] or omit for every integration.
The order of the client tabs, example ['home', 'convos', 'leads', 'kb', 'analytics', 'theme', 'settings', 'prompt']
The magic code of the client, used to sign in to the dashboard.
The index of the client, used to sort the clients.
Whether the client is an org admin or not allowing him to create other users on his org and have more access in the dashboard.
The secret of the client, used to sign in to the dashboard.
The ID of the org this user belongs to, must be defined when creating a client.
Whether the client is an organization admin or not allowing him to create other users on his org and have more access in the dashboard
Whether the client can delegate chats to other users in the org.
Shows on the dashboard and in the web widget whether this client is online of offline for realtime handoff.
Available options:
online, offline Predefined tags for the client, used in the chats tab quickly tag any chat with them.
The Firebase push token of the client used to implement browser notifications.
The notifications settings of the client, by default the client will only receive email notifications for requests.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The timestamp of the last email sent, used by the system to not send a lot of emails to the client.
The preferred language of the client and based on it whole whitelabel dashboard will be translated, MUST BE 2 letter language code
Used internally by system.
Show child attributes
Show child attributes
The timestamp of the last invitation
The canned responses of the client used in the chats tab
Show child attributes
Show child attributes
The Stripe customer ID of the client
Signup source for client onboarding (e.g. stripe_checkout)
Whether the client can create agents
Whether the client can hide the advanced settings
Client onboarding state and progress
Show child attributes
Show child attributes
Flag to identify clients created through signup (triggers onboarding)
The teams this client belongs to (fetched from orgs/{orgId}/teams subcollection based on memberIds)
Show child attributes
Show child attributes
Available options:
vertical, horizontal Show child attributes
Show child attributes