Skip to main content
POST
Set up a hosted brand.json

Authorizations

Authorization
string
header
required

Bearer token in the Authorization header. Two token types are accepted:

  • Organization API key (sk_...) issued via the dashboard. Org-scoped, long-lived, for server-to-server use.
  • User JWT obtained via the OAuth 2.1 authorization code flow with PKCE. User-scoped, short-lived. Discover the authorization server at /.well-known/oauth-authorization-server and the protected-resource metadata at /.well-known/oauth-protected-resource/api.

Body

application/json
domain
string
required
Example:

"acmecorp.com"

brand_name
string
required
brand_json
object

Optional full brand.json draft to host in the registry. Every recognized logo URL must be an absolute HTTPS URL of at most 2048 characters without userinfo credentials, backslashes, or markup-significant characters. The primary brand color must use #RRGGBB format.

logo_url
string<uri>

Absolute HTTPS URL for the brand logo. Userinfo credentials, backslashes, and markup-significant characters are not allowed.

Maximum string length: 2048
Example:

"https://cdn.example.com/brand/logo.svg"

brand_color
string
Pattern: ^#[0-9a-fA-F]{6}$

Response

Brand setup result

domain
string
required
has_brand_json
boolean
required
hosted_brand_json_url
string
required
pointer_snippet
string
required

JSON string for brand.json pointer