Partners

Set a domain's branding

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.

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

Path parameters

idstring required
Example:cmtumr8yj000bd7xabjjsnil8

The customer id returned when the customer was created

domainstring required

The customer's domain name, e.g. smiledental.example

Request body

brandNamestring nullable

Example request

{
  "brandName": "Smile Dental"
}

Response

Saved

successboolean

Example response

{
  "success": true,
  "data": {
    "saved": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.