Skip to main content
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>"
  ]
}
'
{
  "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
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.aitasker.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

brand_id
string<uuid>
required

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.

tagline
string | null
Maximum string length: 200
description
string | null
Maximum string length: 2000
short_name
string | null
Maximum string length: 20
accent_color
string | null
Maximum string length: 32
primary_color
string | null
Maximum string length: 32
font_family
string | null
Maximum string length: 100
font_weight
integer | null
Required range: 100 <= x <= 900
industries
string[] | null
tags
string[] | null

Response

Successful Response

Full payload for the Brand page's partner-mode section.

brand_id
string<uuid>
required
partner_slug
string | null
public_url
string | null
overrides
Overrides · object
agents
PartnerPageAgent · object[]