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

Dashboard API — authenticated by an Atlas console (platform-instance) session, not a key.

5 routes. Each row is one endpoint with its explanation and whether it honours the Idempotency-Key header.

Method & path

Idem

Explanation

GET /v1/dashboard/accounts/:accountId/instances/:instanceId/branding

Branding as stored, plus what the renderers will actually use.

PATCH /v1/dashboard/accounts/:accountId/instances/:instanceId/branding

Update logo and colours for the hosted pages and emails.

POST /v1/dashboard/accounts/:accountId/instances/:instanceId/branding/preview

Render an unsaved branding draft through the real hosted-page renderer; persists nothing.

POST /v1/dashboard/accounts/:accountId/instances/:instanceId/branding/logo

Upload the instance logo (raw image bytes, validated by magic number) to object storage and point branding.logoUrl at it. 503 when image storage is not configured.

POST /v1/dashboard/accounts/:accountId/instances/:instanceId/branding/image

Upload a branding image (logo) as raw bytes; returns its hosted asset URL. Owner or admin.

Was this page helpful?