API Reference
Getting Started
Core Concepts
Backend API — Guides
Frontend API — Guides
OAuth & OpenID Connect — Guides
Enterprise: SSO & SCIM — Guides
Webhooks — Guides
SDKs
Backend API (BAPI)
Frontend API (FAPI)
Dashboard API
Public API
SCIM
OIDC
Platform

Branding

AdminUpdated Sep 11, 2026

Branding

Backend API — secret key (Authorization: Bearer sk_…).

3 routes. Each row is one endpoint with its explanation, required scope, and whether it honours the Idempotency-Key header.

Method & path

Scope

Idem

Explanation

GET /v1/branding

branding:read

Read the instance branding / hosted-page appearance and its resolved (renderer) form.

PATCH /v1/branding

branding:write

Change branding with a PARTIAL merge (unlike auth_config full-replace), validated the way the renderer resolves it — a value it would drop is refused, not silently ignored.

POST /v1/branding/preview

branding:read

Render a draft branding through the real sign-in hosted-page renderer (same sanitizers + CSP) so an agent sees what would ship before saving.

Was this page helpful?
Branding