Skip to content

Branding

Branding controls your site identity and SEO metadata (the <title> and meta description of your public pages).

OperationEndpointScope
Read brandingGET /api/v1/brandingapi:branding:read
Replace brandingPUT /api/v1/brandingapi:branding:write

Get branding

GET /api/v1/branding
json
{
  "data": {
    "site_name": "Your Site",
    "logo_url": null,
    "hero_title": "…",
    "hero_subtitle": null,
    "seo_title": null,
    "seo_description": null,
    "primary_color": null,
    "og_template": "clean"
  }
}

Update branding

PUT /api/v1/branding
Content-Type: application/json

PUT is a full replacement, not a merge. To change one field, GET the current branding first, modify the field, then PUT the whole object back — otherwise omitted fields are cleared.

SEO example (read → modify → write)

bash
# 1. Read current branding
curl https://quizzz.techtranslab.com/api/v1/branding \
  -H "Authorization: Bearer qz_your_key_here" > branding.json

# 2. Edit branding.json: set "seo_title" and "seo_description"

# 3. Write it back
curl -X PUT https://quizzz.techtranslab.com/api/v1/branding \
  -H "Authorization: Bearer qz_your_key_here" \
  -H "Content-Type: application/json" \
  -d @branding.json

The response echoes the updated branding under data.

TechTrans Lab