Make a listing yours
curl --request POST \
--url http://localhost:3000/api/v1/hub/offers/{org}/{brand} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"slug": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/hub/offers/{org}/{brand}"
payload = { "slug": "<string>" }
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({slug: '<string>'})
};
fetch('http://localhost:3000/api/v1/hub/offers/{org}/{brand}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/hub/offers/{org}/{brand}",
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([
'slug' => '<string>'
]),
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 := "http://localhost:3000/api/v1/hub/offers/{org}/{brand}"
payload := strings.NewReader("{\n \"slug\": \"<string>\"\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("http://localhost:3000/api/v1/hub/offers/{org}/{brand}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/hub/offers/{org}/{brand}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"slug\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"slug": "<string>",
"name": "<string>",
"default": true,
"visibility": "private",
"rules": 0,
"createdAt": "2023-11-07T05:31:56Z",
"hub": {
"visibility": "private",
"url": "<string>",
"published": {
"number": 0,
"publishedAt": "2023-11-07T05:31:56Z"
},
"portal": {
"slug": "<string>",
"name": "<string>"
},
"chosen": true,
"pulls": 0,
"delisted": "<string>",
"ref": "<string>",
"verified": "<string>",
"terms": "<string>",
"movedTo": "<string>"
},
"from": "<string>",
"domain": "<string>",
"movedTo": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"detail": "<unknown>"
}
}API Reference
Make a listing yours
Take an offer: a brand in your workspace from the listing’s release (as Start from this brand), with its domain, released and public on BrandHub. The listing goes private, its address leads to yours for good, and its organization’s admins find a resolved claim and an audit entry. No brand moves between organizations. Organization admin, signed in.
Scope: admin.
POST
/
api
/
v1
/
hub
/
offers
/
{org}
/
{brand}
Make a listing yours
curl --request POST \
--url http://localhost:3000/api/v1/hub/offers/{org}/{brand} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"slug": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/hub/offers/{org}/{brand}"
payload = { "slug": "<string>" }
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({slug: '<string>'})
};
fetch('http://localhost:3000/api/v1/hub/offers/{org}/{brand}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/hub/offers/{org}/{brand}",
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([
'slug' => '<string>'
]),
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 := "http://localhost:3000/api/v1/hub/offers/{org}/{brand}"
payload := strings.NewReader("{\n \"slug\": \"<string>\"\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("http://localhost:3000/api/v1/hub/offers/{org}/{brand}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/hub/offers/{org}/{brand}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"slug\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"slug": "<string>",
"name": "<string>",
"default": true,
"visibility": "private",
"rules": 0,
"createdAt": "2023-11-07T05:31:56Z",
"hub": {
"visibility": "private",
"url": "<string>",
"published": {
"number": 0,
"publishedAt": "2023-11-07T05:31:56Z"
},
"portal": {
"slug": "<string>",
"name": "<string>"
},
"chosen": true,
"pulls": 0,
"delisted": "<string>",
"ref": "<string>",
"verified": "<string>",
"terms": "<string>",
"movedTo": "<string>"
},
"from": "<string>",
"domain": "<string>",
"movedTo": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"detail": "<unknown>"
}
}Authorizations
bearersession
An API key: ab_...
Body
application/json
The new brand's slug in your workspace; the listing's when left out
Maximum string length:
60Pattern:
^[a-z0-9]+(-[a-z0-9]+)*$Response
Your brand, and where it is on BrandHub
Show child attributes
Show child attributes