Hub
Update hub identity
Partial update of identity fields: name, description, theme, colors, support. Access settings live under /hub/access and domain under /hub/domain. Sending only the fields you want to change is enough; null/absent fields are not touched.
PATCH
/
public
/
api
/
v1
/
hub
Update hub identity
curl --request PATCH \
--url https://api.gennia.ai/public/api/v1/hub \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"description": "<string>",
"name": "<string>",
"pricingWidgetColor": "<string>",
"primaryColor": "<string>",
"secondaryColor": "<string>",
"supportChannelValue": "<string>",
"supportEmail": "<string>",
"supportWhatsappMessage": "<string>",
"theme": "<string>"
}
'import requests
url = "https://api.gennia.ai/public/api/v1/hub"
payload = {
"description": "<string>",
"name": "<string>",
"pricingWidgetColor": "<string>",
"primaryColor": "<string>",
"secondaryColor": "<string>",
"supportChannelValue": "<string>",
"supportEmail": "<string>",
"supportWhatsappMessage": "<string>",
"theme": "<string>"
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: '<string>',
name: '<string>',
pricingWidgetColor: '<string>',
primaryColor: '<string>',
secondaryColor: '<string>',
supportChannelValue: '<string>',
supportEmail: '<string>',
supportWhatsappMessage: '<string>',
theme: '<string>'
})
};
fetch('https://api.gennia.ai/public/api/v1/hub', 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://api.gennia.ai/public/api/v1/hub",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'description' => '<string>',
'name' => '<string>',
'pricingWidgetColor' => '<string>',
'primaryColor' => '<string>',
'secondaryColor' => '<string>',
'supportChannelValue' => '<string>',
'supportEmail' => '<string>',
'supportWhatsappMessage' => '<string>',
'theme' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$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://api.gennia.ai/public/api/v1/hub"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"pricingWidgetColor\": \"<string>\",\n \"primaryColor\": \"<string>\",\n \"secondaryColor\": \"<string>\",\n \"supportChannelValue\": \"<string>\",\n \"supportEmail\": \"<string>\",\n \"supportWhatsappMessage\": \"<string>\",\n \"theme\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
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.patch("https://api.gennia.ai/public/api/v1/hub")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"pricingWidgetColor\": \"<string>\",\n \"primaryColor\": \"<string>\",\n \"secondaryColor\": \"<string>\",\n \"supportChannelValue\": \"<string>\",\n \"supportEmail\": \"<string>\",\n \"supportWhatsappMessage\": \"<string>\",\n \"theme\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gennia.ai/public/api/v1/hub")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"pricingWidgetColor\": \"<string>\",\n \"primaryColor\": \"<string>\",\n \"secondaryColor\": \"<string>\",\n \"supportChannelValue\": \"<string>\",\n \"supportEmail\": \"<string>\",\n \"supportWhatsappMessage\": \"<string>\",\n \"theme\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"createdAt": "2023-11-07T05:31:56Z",
"defaultPlan": {
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"description": "<string>",
"hubUrl": "<string>",
"loginBannerUrl": "<string>",
"logoEmailUrl": "<string>",
"logoHorizontalUrl": "<string>",
"logoIconUrl": "<string>",
"name": "<string>",
"pricingWidgetColor": "<string>",
"primaryColor": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"secondaryColor": "<string>",
"selfServiceEnabled": true,
"subdomain": "<string>",
"supportChannelValue": "<string>",
"supportEmail": "<string>",
"supportWhatsappMessage": "<string>",
"theme": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"createdAt": "2023-11-07T05:31:56Z",
"defaultPlan": {
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"description": "<string>",
"hubUrl": "<string>",
"loginBannerUrl": "<string>",
"logoEmailUrl": "<string>",
"logoHorizontalUrl": "<string>",
"logoIconUrl": "<string>",
"name": "<string>",
"pricingWidgetColor": "<string>",
"primaryColor": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"secondaryColor": "<string>",
"selfServiceEnabled": true,
"subdomain": "<string>",
"supportChannelValue": "<string>",
"supportEmail": "<string>",
"supportWhatsappMessage": "<string>",
"theme": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"createdAt": "2023-11-07T05:31:56Z",
"defaultPlan": {
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"description": "<string>",
"hubUrl": "<string>",
"loginBannerUrl": "<string>",
"logoEmailUrl": "<string>",
"logoHorizontalUrl": "<string>",
"logoIconUrl": "<string>",
"name": "<string>",
"pricingWidgetColor": "<string>",
"primaryColor": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"secondaryColor": "<string>",
"selfServiceEnabled": true,
"subdomain": "<string>",
"supportChannelValue": "<string>",
"supportEmail": "<string>",
"supportWhatsappMessage": "<string>",
"theme": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}Autorizações
Corpo
application/json
Maximum string length:
500Required string length:
3 - 150Pattern:
^#[0-9A-Fa-f]{6}$Pattern:
^#[0-9A-Fa-f]{6}$Pattern:
^#[0-9A-Fa-f]{6}$Opções disponíveis:
email, whatsapp, url Maximum string length:
500Maximum string length:
255Maximum string length:
500Pattern:
^(light|dark)$Resposta
OK
Opções disponíveis:
public, private Show child attributes
Show child attributes
Opções disponíveis:
email, whatsapp, url Esta página foi útil?
Anterior
Delete hub logoRemoves the logo for the given type (clears the path and deletes the file from storage). Idempotent: removing an already-empty logo returns 200 with the hub unchanged.
Próximo
⌘I
Update hub identity
curl --request PATCH \
--url https://api.gennia.ai/public/api/v1/hub \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"description": "<string>",
"name": "<string>",
"pricingWidgetColor": "<string>",
"primaryColor": "<string>",
"secondaryColor": "<string>",
"supportChannelValue": "<string>",
"supportEmail": "<string>",
"supportWhatsappMessage": "<string>",
"theme": "<string>"
}
'import requests
url = "https://api.gennia.ai/public/api/v1/hub"
payload = {
"description": "<string>",
"name": "<string>",
"pricingWidgetColor": "<string>",
"primaryColor": "<string>",
"secondaryColor": "<string>",
"supportChannelValue": "<string>",
"supportEmail": "<string>",
"supportWhatsappMessage": "<string>",
"theme": "<string>"
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: '<string>',
name: '<string>',
pricingWidgetColor: '<string>',
primaryColor: '<string>',
secondaryColor: '<string>',
supportChannelValue: '<string>',
supportEmail: '<string>',
supportWhatsappMessage: '<string>',
theme: '<string>'
})
};
fetch('https://api.gennia.ai/public/api/v1/hub', 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://api.gennia.ai/public/api/v1/hub",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'description' => '<string>',
'name' => '<string>',
'pricingWidgetColor' => '<string>',
'primaryColor' => '<string>',
'secondaryColor' => '<string>',
'supportChannelValue' => '<string>',
'supportEmail' => '<string>',
'supportWhatsappMessage' => '<string>',
'theme' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$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://api.gennia.ai/public/api/v1/hub"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"pricingWidgetColor\": \"<string>\",\n \"primaryColor\": \"<string>\",\n \"secondaryColor\": \"<string>\",\n \"supportChannelValue\": \"<string>\",\n \"supportEmail\": \"<string>\",\n \"supportWhatsappMessage\": \"<string>\",\n \"theme\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
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.patch("https://api.gennia.ai/public/api/v1/hub")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"pricingWidgetColor\": \"<string>\",\n \"primaryColor\": \"<string>\",\n \"secondaryColor\": \"<string>\",\n \"supportChannelValue\": \"<string>\",\n \"supportEmail\": \"<string>\",\n \"supportWhatsappMessage\": \"<string>\",\n \"theme\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gennia.ai/public/api/v1/hub")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"pricingWidgetColor\": \"<string>\",\n \"primaryColor\": \"<string>\",\n \"secondaryColor\": \"<string>\",\n \"supportChannelValue\": \"<string>\",\n \"supportEmail\": \"<string>\",\n \"supportWhatsappMessage\": \"<string>\",\n \"theme\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"createdAt": "2023-11-07T05:31:56Z",
"defaultPlan": {
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"description": "<string>",
"hubUrl": "<string>",
"loginBannerUrl": "<string>",
"logoEmailUrl": "<string>",
"logoHorizontalUrl": "<string>",
"logoIconUrl": "<string>",
"name": "<string>",
"pricingWidgetColor": "<string>",
"primaryColor": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"secondaryColor": "<string>",
"selfServiceEnabled": true,
"subdomain": "<string>",
"supportChannelValue": "<string>",
"supportEmail": "<string>",
"supportWhatsappMessage": "<string>",
"theme": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"createdAt": "2023-11-07T05:31:56Z",
"defaultPlan": {
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"description": "<string>",
"hubUrl": "<string>",
"loginBannerUrl": "<string>",
"logoEmailUrl": "<string>",
"logoHorizontalUrl": "<string>",
"logoIconUrl": "<string>",
"name": "<string>",
"pricingWidgetColor": "<string>",
"primaryColor": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"secondaryColor": "<string>",
"selfServiceEnabled": true,
"subdomain": "<string>",
"supportChannelValue": "<string>",
"supportEmail": "<string>",
"supportWhatsappMessage": "<string>",
"theme": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"createdAt": "2023-11-07T05:31:56Z",
"defaultPlan": {
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"description": "<string>",
"hubUrl": "<string>",
"loginBannerUrl": "<string>",
"logoEmailUrl": "<string>",
"logoHorizontalUrl": "<string>",
"logoIconUrl": "<string>",
"name": "<string>",
"pricingWidgetColor": "<string>",
"primaryColor": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"secondaryColor": "<string>",
"selfServiceEnabled": true,
"subdomain": "<string>",
"supportChannelValue": "<string>",
"supportEmail": "<string>",
"supportWhatsappMessage": "<string>",
"theme": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
