---
title: "Set a domain's branding"
method: PUT
path: "/customers/{id}/domains/{domain}/branding"
tags: ["Partners"]
---

# Set a domain's branding

`PUT /customers/{id}/domains/{domain}/branding`

## Request

- Base URL: `https://faivelo.com/api/partner`
- URL: `https://faivelo.com/api/partner/customers/{id}/domains/{domain}/branding`
- Auth: HTTP bearer

The name and logo the customer's webmail shows for this domain. Anything left unset falls back to your partner brand (logo, sign-in photo, theme), then to Faivelo. Requires `partner:write`.

## Path parameters

- `id` string, required
- `domain` string, required

## Request body

- PartnerDomainBranding
  - `brandName` string, nullable
  - `logo` object, nullable: PNG, JPEG or WebP under 500KB, base64 encoded. Null removes the logo.
    - `base64` string
    - `mimeType` 'image/png' | 'image/jpeg' | 'image/webp'

## Response `200`

Saved

- object
  - `success` boolean
  - `data` object
    - `saved` boolean

## Other responses

- `400`: Invalid input
- `401`: Missing or invalid API key, or not a partner key
- `403`: The key lacks the required scope, or provisioning is refused (partner paused, customer cap reached)
- `404`: Not found, including any customer that is not yours
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/faivelo/apis/faivelo-api.md) · [All operations](https://skmtc.dev/faivelo/apis/faivelo-api/llms.txt) · [OpenAPI document](https://skmtc.dev/faivelo/apis/faivelo-api/revisions/a7413ddea5d1?raw)