Create or Update Agency
curl --request POST \
--url https://eu-gcp-api.vg-stuff.com/v3/agency \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agency": {
"agencyId": "<string>",
"name": "<string>",
"squarePhotoURL": "<string>",
"darkModeSquarePhotourl": "<string>",
"faviconURL": "<string>",
"brandingText": "<string>",
"customDomain": "<string>",
"VGsubDomain": "<string>",
"lastModified": 123,
"withVGBranding": true,
"googleFont": "<string>",
"mainWebsite": "<string>",
"supportEmail": "<string>",
"tosPage": "<string>",
"privacyPolicypPage": "<string>",
"confirmedRegion": "<string>",
"customThemeJSONString": "<string>",
"isVerifiedSubDomain": true,
"isVerifiedCustomDomain": true,
"secondaryColorHex": "<string>",
"settings": {
"disablePasswordLogin": true,
"enableClientSignup": true,
"clientOnboarding": {}
}
}
}
'import requests
url = "https://eu-gcp-api.vg-stuff.com/v3/agency"
payload = { "agency": {
"agencyId": "<string>",
"name": "<string>",
"squarePhotoURL": "<string>",
"darkModeSquarePhotourl": "<string>",
"faviconURL": "<string>",
"brandingText": "<string>",
"customDomain": "<string>",
"VGsubDomain": "<string>",
"lastModified": 123,
"withVGBranding": True,
"googleFont": "<string>",
"mainWebsite": "<string>",
"supportEmail": "<string>",
"tosPage": "<string>",
"privacyPolicypPage": "<string>",
"confirmedRegion": "<string>",
"customThemeJSONString": "<string>",
"isVerifiedSubDomain": True,
"isVerifiedCustomDomain": True,
"secondaryColorHex": "<string>",
"settings": {
"disablePasswordLogin": True,
"enableClientSignup": True,
"clientOnboarding": {}
}
} }
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({
agency: {
agencyId: '<string>',
name: '<string>',
squarePhotoURL: '<string>',
darkModeSquarePhotourl: '<string>',
faviconURL: '<string>',
brandingText: '<string>',
customDomain: '<string>',
VGsubDomain: '<string>',
lastModified: 123,
withVGBranding: true,
googleFont: '<string>',
mainWebsite: '<string>',
supportEmail: '<string>',
tosPage: '<string>',
privacyPolicypPage: '<string>',
confirmedRegion: '<string>',
customThemeJSONString: '<string>',
isVerifiedSubDomain: true,
isVerifiedCustomDomain: true,
secondaryColorHex: '<string>',
settings: {disablePasswordLogin: true, enableClientSignup: true, clientOnboarding: {}}
}
})
};
fetch('https://eu-gcp-api.vg-stuff.com/v3/agency', 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/agency",
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([
'agency' => [
'agencyId' => '<string>',
'name' => '<string>',
'squarePhotoURL' => '<string>',
'darkModeSquarePhotourl' => '<string>',
'faviconURL' => '<string>',
'brandingText' => '<string>',
'customDomain' => '<string>',
'VGsubDomain' => '<string>',
'lastModified' => 123,
'withVGBranding' => true,
'googleFont' => '<string>',
'mainWebsite' => '<string>',
'supportEmail' => '<string>',
'tosPage' => '<string>',
'privacyPolicypPage' => '<string>',
'confirmedRegion' => '<string>',
'customThemeJSONString' => '<string>',
'isVerifiedSubDomain' => true,
'isVerifiedCustomDomain' => true,
'secondaryColorHex' => '<string>',
'settings' => [
'disablePasswordLogin' => true,
'enableClientSignup' => true,
'clientOnboarding' => [
]
]
]
]),
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/agency"
payload := strings.NewReader("{\n \"agency\": {\n \"agencyId\": \"<string>\",\n \"name\": \"<string>\",\n \"squarePhotoURL\": \"<string>\",\n \"darkModeSquarePhotourl\": \"<string>\",\n \"faviconURL\": \"<string>\",\n \"brandingText\": \"<string>\",\n \"customDomain\": \"<string>\",\n \"VGsubDomain\": \"<string>\",\n \"lastModified\": 123,\n \"withVGBranding\": true,\n \"googleFont\": \"<string>\",\n \"mainWebsite\": \"<string>\",\n \"supportEmail\": \"<string>\",\n \"tosPage\": \"<string>\",\n \"privacyPolicypPage\": \"<string>\",\n \"confirmedRegion\": \"<string>\",\n \"customThemeJSONString\": \"<string>\",\n \"isVerifiedSubDomain\": true,\n \"isVerifiedCustomDomain\": true,\n \"secondaryColorHex\": \"<string>\",\n \"settings\": {\n \"disablePasswordLogin\": true,\n \"enableClientSignup\": true,\n \"clientOnboarding\": {}\n }\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/agency")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agency\": {\n \"agencyId\": \"<string>\",\n \"name\": \"<string>\",\n \"squarePhotoURL\": \"<string>\",\n \"darkModeSquarePhotourl\": \"<string>\",\n \"faviconURL\": \"<string>\",\n \"brandingText\": \"<string>\",\n \"customDomain\": \"<string>\",\n \"VGsubDomain\": \"<string>\",\n \"lastModified\": 123,\n \"withVGBranding\": true,\n \"googleFont\": \"<string>\",\n \"mainWebsite\": \"<string>\",\n \"supportEmail\": \"<string>\",\n \"tosPage\": \"<string>\",\n \"privacyPolicypPage\": \"<string>\",\n \"confirmedRegion\": \"<string>\",\n \"customThemeJSONString\": \"<string>\",\n \"isVerifiedSubDomain\": true,\n \"isVerifiedCustomDomain\": true,\n \"secondaryColorHex\": \"<string>\",\n \"settings\": {\n \"disablePasswordLogin\": true,\n \"enableClientSignup\": true,\n \"clientOnboarding\": {}\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://eu-gcp-api.vg-stuff.com/v3/agency")
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 \"agency\": {\n \"agencyId\": \"<string>\",\n \"name\": \"<string>\",\n \"squarePhotoURL\": \"<string>\",\n \"darkModeSquarePhotourl\": \"<string>\",\n \"faviconURL\": \"<string>\",\n \"brandingText\": \"<string>\",\n \"customDomain\": \"<string>\",\n \"VGsubDomain\": \"<string>\",\n \"lastModified\": 123,\n \"withVGBranding\": true,\n \"googleFont\": \"<string>\",\n \"mainWebsite\": \"<string>\",\n \"supportEmail\": \"<string>\",\n \"tosPage\": \"<string>\",\n \"privacyPolicypPage\": \"<string>\",\n \"confirmedRegion\": \"<string>\",\n \"customThemeJSONString\": \"<string>\",\n \"isVerifiedSubDomain\": true,\n \"isVerifiedCustomDomain\": true,\n \"secondaryColorHex\": \"<string>\",\n \"settings\": {\n \"disablePasswordLogin\": true,\n \"enableClientSignup\": true,\n \"clientOnboarding\": {}\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"ID": "<string>",
"userId": "<string>",
"agencyId": "<string>",
"name": "<string>",
"squarePhotoURL": "<string>",
"darkModeSquarePhotourl": "<string>",
"faviconURL": "<string>",
"brandingText": "<string>",
"customDomain": "<string>",
"VGsubDomain": "<string>",
"ts": 123,
"lastModified": 123,
"withVGBranding": true,
"googleFont": "<string>",
"mainWebsite": "<string>",
"supportEmail": "<string>",
"tosPage": "<string>",
"privacyPolicypPage": "<string>",
"confirmedRegion": "<string>",
"customThemeJSONString": "<string>",
"isVerifiedSubDomain": true,
"isVerifiedCustomDomain": true,
"secondaryColorHex": "<string>",
"settings": {
"disablePasswordLogin": true,
"enableClientSignup": true,
"clientOnboarding": {}
}
}
}{
"message": "<string>",
"code": "<string>",
"issues": [
{
"message": "<string>"
}
]
}Agency
Create or Update Agency
Create an agency if missing, otherwise merge provided fields
POST
/
agency
Create or Update Agency
curl --request POST \
--url https://eu-gcp-api.vg-stuff.com/v3/agency \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agency": {
"agencyId": "<string>",
"name": "<string>",
"squarePhotoURL": "<string>",
"darkModeSquarePhotourl": "<string>",
"faviconURL": "<string>",
"brandingText": "<string>",
"customDomain": "<string>",
"VGsubDomain": "<string>",
"lastModified": 123,
"withVGBranding": true,
"googleFont": "<string>",
"mainWebsite": "<string>",
"supportEmail": "<string>",
"tosPage": "<string>",
"privacyPolicypPage": "<string>",
"confirmedRegion": "<string>",
"customThemeJSONString": "<string>",
"isVerifiedSubDomain": true,
"isVerifiedCustomDomain": true,
"secondaryColorHex": "<string>",
"settings": {
"disablePasswordLogin": true,
"enableClientSignup": true,
"clientOnboarding": {}
}
}
}
'import requests
url = "https://eu-gcp-api.vg-stuff.com/v3/agency"
payload = { "agency": {
"agencyId": "<string>",
"name": "<string>",
"squarePhotoURL": "<string>",
"darkModeSquarePhotourl": "<string>",
"faviconURL": "<string>",
"brandingText": "<string>",
"customDomain": "<string>",
"VGsubDomain": "<string>",
"lastModified": 123,
"withVGBranding": True,
"googleFont": "<string>",
"mainWebsite": "<string>",
"supportEmail": "<string>",
"tosPage": "<string>",
"privacyPolicypPage": "<string>",
"confirmedRegion": "<string>",
"customThemeJSONString": "<string>",
"isVerifiedSubDomain": True,
"isVerifiedCustomDomain": True,
"secondaryColorHex": "<string>",
"settings": {
"disablePasswordLogin": True,
"enableClientSignup": True,
"clientOnboarding": {}
}
} }
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({
agency: {
agencyId: '<string>',
name: '<string>',
squarePhotoURL: '<string>',
darkModeSquarePhotourl: '<string>',
faviconURL: '<string>',
brandingText: '<string>',
customDomain: '<string>',
VGsubDomain: '<string>',
lastModified: 123,
withVGBranding: true,
googleFont: '<string>',
mainWebsite: '<string>',
supportEmail: '<string>',
tosPage: '<string>',
privacyPolicypPage: '<string>',
confirmedRegion: '<string>',
customThemeJSONString: '<string>',
isVerifiedSubDomain: true,
isVerifiedCustomDomain: true,
secondaryColorHex: '<string>',
settings: {disablePasswordLogin: true, enableClientSignup: true, clientOnboarding: {}}
}
})
};
fetch('https://eu-gcp-api.vg-stuff.com/v3/agency', 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/agency",
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([
'agency' => [
'agencyId' => '<string>',
'name' => '<string>',
'squarePhotoURL' => '<string>',
'darkModeSquarePhotourl' => '<string>',
'faviconURL' => '<string>',
'brandingText' => '<string>',
'customDomain' => '<string>',
'VGsubDomain' => '<string>',
'lastModified' => 123,
'withVGBranding' => true,
'googleFont' => '<string>',
'mainWebsite' => '<string>',
'supportEmail' => '<string>',
'tosPage' => '<string>',
'privacyPolicypPage' => '<string>',
'confirmedRegion' => '<string>',
'customThemeJSONString' => '<string>',
'isVerifiedSubDomain' => true,
'isVerifiedCustomDomain' => true,
'secondaryColorHex' => '<string>',
'settings' => [
'disablePasswordLogin' => true,
'enableClientSignup' => true,
'clientOnboarding' => [
]
]
]
]),
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/agency"
payload := strings.NewReader("{\n \"agency\": {\n \"agencyId\": \"<string>\",\n \"name\": \"<string>\",\n \"squarePhotoURL\": \"<string>\",\n \"darkModeSquarePhotourl\": \"<string>\",\n \"faviconURL\": \"<string>\",\n \"brandingText\": \"<string>\",\n \"customDomain\": \"<string>\",\n \"VGsubDomain\": \"<string>\",\n \"lastModified\": 123,\n \"withVGBranding\": true,\n \"googleFont\": \"<string>\",\n \"mainWebsite\": \"<string>\",\n \"supportEmail\": \"<string>\",\n \"tosPage\": \"<string>\",\n \"privacyPolicypPage\": \"<string>\",\n \"confirmedRegion\": \"<string>\",\n \"customThemeJSONString\": \"<string>\",\n \"isVerifiedSubDomain\": true,\n \"isVerifiedCustomDomain\": true,\n \"secondaryColorHex\": \"<string>\",\n \"settings\": {\n \"disablePasswordLogin\": true,\n \"enableClientSignup\": true,\n \"clientOnboarding\": {}\n }\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/agency")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agency\": {\n \"agencyId\": \"<string>\",\n \"name\": \"<string>\",\n \"squarePhotoURL\": \"<string>\",\n \"darkModeSquarePhotourl\": \"<string>\",\n \"faviconURL\": \"<string>\",\n \"brandingText\": \"<string>\",\n \"customDomain\": \"<string>\",\n \"VGsubDomain\": \"<string>\",\n \"lastModified\": 123,\n \"withVGBranding\": true,\n \"googleFont\": \"<string>\",\n \"mainWebsite\": \"<string>\",\n \"supportEmail\": \"<string>\",\n \"tosPage\": \"<string>\",\n \"privacyPolicypPage\": \"<string>\",\n \"confirmedRegion\": \"<string>\",\n \"customThemeJSONString\": \"<string>\",\n \"isVerifiedSubDomain\": true,\n \"isVerifiedCustomDomain\": true,\n \"secondaryColorHex\": \"<string>\",\n \"settings\": {\n \"disablePasswordLogin\": true,\n \"enableClientSignup\": true,\n \"clientOnboarding\": {}\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://eu-gcp-api.vg-stuff.com/v3/agency")
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 \"agency\": {\n \"agencyId\": \"<string>\",\n \"name\": \"<string>\",\n \"squarePhotoURL\": \"<string>\",\n \"darkModeSquarePhotourl\": \"<string>\",\n \"faviconURL\": \"<string>\",\n \"brandingText\": \"<string>\",\n \"customDomain\": \"<string>\",\n \"VGsubDomain\": \"<string>\",\n \"lastModified\": 123,\n \"withVGBranding\": true,\n \"googleFont\": \"<string>\",\n \"mainWebsite\": \"<string>\",\n \"supportEmail\": \"<string>\",\n \"tosPage\": \"<string>\",\n \"privacyPolicypPage\": \"<string>\",\n \"confirmedRegion\": \"<string>\",\n \"customThemeJSONString\": \"<string>\",\n \"isVerifiedSubDomain\": true,\n \"isVerifiedCustomDomain\": true,\n \"secondaryColorHex\": \"<string>\",\n \"settings\": {\n \"disablePasswordLogin\": true,\n \"enableClientSignup\": true,\n \"clientOnboarding\": {}\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"ID": "<string>",
"userId": "<string>",
"agencyId": "<string>",
"name": "<string>",
"squarePhotoURL": "<string>",
"darkModeSquarePhotourl": "<string>",
"faviconURL": "<string>",
"brandingText": "<string>",
"customDomain": "<string>",
"VGsubDomain": "<string>",
"ts": 123,
"lastModified": 123,
"withVGBranding": true,
"googleFont": "<string>",
"mainWebsite": "<string>",
"supportEmail": "<string>",
"tosPage": "<string>",
"privacyPolicypPage": "<string>",
"confirmedRegion": "<string>",
"customThemeJSONString": "<string>",
"isVerifiedSubDomain": true,
"isVerifiedCustomDomain": true,
"secondaryColorHex": "<string>",
"settings": {
"disablePasswordLogin": true,
"enableClientSignup": true,
"clientOnboarding": {}
}
}
}{
"message": "<string>",
"code": "<string>",
"issues": [
{
"message": "<string>"
}
]
}name is required when creating. Fields like userId, ID, ts, and secret cannot be overwritten via the body.Example Request
{
"agency": {
"name": "Acme Agency",
"brandingText": "Powered by Acme",
"supportEmail": "support@acme.example",
"mainWebsite": "https://acme.example"
}
}
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Show child attributes
Show child attributes
⌘I
