Skip to content
Dashboard
Theme
Theme

Upload a favicon

POST /v1/branding/favicon: Upload a favicon.

View Markdown

POST /v1/branding/favicon

Stores a PNG favicon (16 to 512 pixels, square, at most 256 KiB, re-encoded without metadata) on the assets host and returns its URL for favicon_url. Pro plan and above; other plans answer plan_limit_reached. Anything else answers logo_invalid.

Scope
branding:write
Auth
Secret key (sk_…)
Since
1.0
  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

  • Idempotency-Key string

    Honoured for 24 h; a replay returns the original response.

    min length 1 · max length 255

  • data string Required

    The file, standard base64 (padding required).

    min length 4 · max length 699052

Errors share one shape; see the error code catalogue.

curl -X POST \
"https://api.ohauthcat.com/v1/branding/favicon" \
-H "Authorization: Bearer $OHAUTHCAT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"data": "example_data"
}'
Response 201
{
"object": "branding_favicon",
"favicon_url": "https://app.acme.com/callback",
"size_bytes": 1
}