Create Global Brand
curl --request POST \
--url https://api.peec.ai/customer/v1/global-brands \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "Nike",
"project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb"
}
'import requests
url = "https://api.peec.ai/customer/v1/global-brands"
payload = {
"name": "Nike",
"project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'Nike', project_id: 'or_f45b94ba-5e35-4982-93ed-285e72ee14eb'})
};
fetch('https://api.peec.ai/customer/v1/global-brands', 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.peec.ai/customer/v1/global-brands",
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' => 'Nike',
'project_id' => 'or_f45b94ba-5e35-4982-93ed-285e72ee14eb'
]),
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.peec.ai/customer/v1/global-brands"
payload := strings.NewReader("{\n \"name\": \"Nike\",\n \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.peec.ai/customer/v1/global-brands")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Nike\",\n \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.peec.ai/customer/v1/global-brands")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Nike\",\n \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\"\n}"
response = http.request(request)
puts response.read_body{
"id": "019ecb6e-d030-7222-b531-b371fe9db583",
"name": "Nike"
}{
"message": "<string>"
}Products
Create Global Brand
Create a brand and return its id — pass it as a product’s global_brand_id when creating products. The returned name is the brand’s canonical name and may differ slightly from the name you sent. This is separate from POST /brands, which creates a brand a project tracks for AI-visibility reporting.
POST
/
global-brands
Create Global Brand
curl --request POST \
--url https://api.peec.ai/customer/v1/global-brands \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "Nike",
"project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb"
}
'import requests
url = "https://api.peec.ai/customer/v1/global-brands"
payload = {
"name": "Nike",
"project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'Nike', project_id: 'or_f45b94ba-5e35-4982-93ed-285e72ee14eb'})
};
fetch('https://api.peec.ai/customer/v1/global-brands', 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.peec.ai/customer/v1/global-brands",
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' => 'Nike',
'project_id' => 'or_f45b94ba-5e35-4982-93ed-285e72ee14eb'
]),
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.peec.ai/customer/v1/global-brands"
payload := strings.NewReader("{\n \"name\": \"Nike\",\n \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.peec.ai/customer/v1/global-brands")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Nike\",\n \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.peec.ai/customer/v1/global-brands")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Nike\",\n \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\"\n}"
response = http.request(request)
puts response.read_body{
"id": "019ecb6e-d030-7222-b531-b371fe9db583",
"name": "Nike"
}{
"message": "<string>"
}Authorizations
APIKeyHeaderAPIKeyQueryBearerAuth
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Response
The brand
The brand
The global_brand_id — pass this as a product's brand when creating products.
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Example:
"019ecb6e-d030-7222-b531-b371fe9db583"
The brand's canonical name. May differ slightly from the name you sent, since an existing brand is reused where one is found.
Example:
"Nike"
