Update Partner Page
curl --request PATCH \
--url https://api.example.com/api/v1/brands/{brand_id}/partner-page \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"tagline": "<string>",
"description": "<string>",
"short_name": "<string>",
"accent_color": "<string>",
"primary_color": "<string>",
"font_family": "<string>",
"font_weight": 500,
"industries": [
"<string>"
],
"tags": [
"<string>"
]
}
'import requests
url = "https://api.example.com/api/v1/brands/{brand_id}/partner-page"
payload = {
"tagline": "<string>",
"description": "<string>",
"short_name": "<string>",
"accent_color": "<string>",
"primary_color": "<string>",
"font_family": "<string>",
"font_weight": 500,
"industries": ["<string>"],
"tags": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
tagline: '<string>',
description: '<string>',
short_name: '<string>',
accent_color: '<string>',
primary_color: '<string>',
font_family: '<string>',
font_weight: 500,
industries: ['<string>'],
tags: ['<string>']
})
};
fetch('https://api.example.com/api/v1/brands/{brand_id}/partner-page', 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.example.com/api/v1/brands/{brand_id}/partner-page",
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([
'tagline' => '<string>',
'description' => '<string>',
'short_name' => '<string>',
'accent_color' => '<string>',
'primary_color' => '<string>',
'font_family' => '<string>',
'font_weight' => 500,
'industries' => [
'<string>'
],
'tags' => [
'<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 := "https://api.example.com/api/v1/brands/{brand_id}/partner-page"
payload := strings.NewReader("{\n \"tagline\": \"<string>\",\n \"description\": \"<string>\",\n \"short_name\": \"<string>\",\n \"accent_color\": \"<string>\",\n \"primary_color\": \"<string>\",\n \"font_family\": \"<string>\",\n \"font_weight\": 500,\n \"industries\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.example.com/api/v1/brands/{brand_id}/partner-page")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"tagline\": \"<string>\",\n \"description\": \"<string>\",\n \"short_name\": \"<string>\",\n \"accent_color\": \"<string>\",\n \"primary_color\": \"<string>\",\n \"font_family\": \"<string>\",\n \"font_weight\": 500,\n \"industries\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/brands/{brand_id}/partner-page")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tagline\": \"<string>\",\n \"description\": \"<string>\",\n \"short_name\": \"<string>\",\n \"accent_color\": \"<string>\",\n \"primary_color\": \"<string>\",\n \"font_family\": \"<string>\",\n \"font_weight\": 500,\n \"industries\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"partner_slug": "<string>",
"public_url": "<string>",
"overrides": {},
"agents": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"name": "<string>",
"visibility_state": "<string>",
"enabled_by_owner": true,
"aihire_enabled": true,
"aitasker_enabled": true,
"description": "<string>",
"base_rate_usd": 123
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Brands
Update Partner Page
Update partner-page presentation. Writes to the primary (first-created) agent’s partner_overrides JSONB so first-non-null merge picks these up.
400 when brand has no partner_slug — private brands can’t publish a partner page, so the endpoint short-circuits instead of silently writing data nothing reads.
PATCH
/
api
/
v1
/
brands
/
{brand_id}
/
partner-page
Update Partner Page
curl --request PATCH \
--url https://api.example.com/api/v1/brands/{brand_id}/partner-page \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"tagline": "<string>",
"description": "<string>",
"short_name": "<string>",
"accent_color": "<string>",
"primary_color": "<string>",
"font_family": "<string>",
"font_weight": 500,
"industries": [
"<string>"
],
"tags": [
"<string>"
]
}
'import requests
url = "https://api.example.com/api/v1/brands/{brand_id}/partner-page"
payload = {
"tagline": "<string>",
"description": "<string>",
"short_name": "<string>",
"accent_color": "<string>",
"primary_color": "<string>",
"font_family": "<string>",
"font_weight": 500,
"industries": ["<string>"],
"tags": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
tagline: '<string>',
description: '<string>',
short_name: '<string>',
accent_color: '<string>',
primary_color: '<string>',
font_family: '<string>',
font_weight: 500,
industries: ['<string>'],
tags: ['<string>']
})
};
fetch('https://api.example.com/api/v1/brands/{brand_id}/partner-page', 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.example.com/api/v1/brands/{brand_id}/partner-page",
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([
'tagline' => '<string>',
'description' => '<string>',
'short_name' => '<string>',
'accent_color' => '<string>',
'primary_color' => '<string>',
'font_family' => '<string>',
'font_weight' => 500,
'industries' => [
'<string>'
],
'tags' => [
'<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 := "https://api.example.com/api/v1/brands/{brand_id}/partner-page"
payload := strings.NewReader("{\n \"tagline\": \"<string>\",\n \"description\": \"<string>\",\n \"short_name\": \"<string>\",\n \"accent_color\": \"<string>\",\n \"primary_color\": \"<string>\",\n \"font_family\": \"<string>\",\n \"font_weight\": 500,\n \"industries\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.example.com/api/v1/brands/{brand_id}/partner-page")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"tagline\": \"<string>\",\n \"description\": \"<string>\",\n \"short_name\": \"<string>\",\n \"accent_color\": \"<string>\",\n \"primary_color\": \"<string>\",\n \"font_family\": \"<string>\",\n \"font_weight\": 500,\n \"industries\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/brands/{brand_id}/partner-page")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tagline\": \"<string>\",\n \"description\": \"<string>\",\n \"short_name\": \"<string>\",\n \"accent_color\": \"<string>\",\n \"primary_color\": \"<string>\",\n \"font_family\": \"<string>\",\n \"font_weight\": 500,\n \"industries\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"partner_slug": "<string>",
"public_url": "<string>",
"overrides": {},
"agents": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"name": "<string>",
"visibility_state": "<string>",
"enabled_by_owner": true,
"aihire_enabled": true,
"aitasker_enabled": true,
"description": "<string>",
"base_rate_usd": 123
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Partial update of the partner page presentation. Writes to the primary (first) linked agent's partner_overrides JSONB.
Any field left None is preserved. Pass empty list / empty string to clear.
Maximum string length:
200Maximum string length:
2000Maximum string length:
20Maximum string length:
32Maximum string length:
32Maximum string length:
100Required range:
100 <= x <= 900Was this page helpful?
⌘I