Branding and white label

Put your brand on the experience your customers see: your domain, logo, colours, and the sender name on emails.

Put your brand on the experience your customers see: your domain, logo, colours, and the sender name on emails.

White-label branding applies to the dashboard your customers log into, the connection pages their business owners use, and the emails we send on your behalf. Set it once per partner or per account.

You'll need a partner or account token.

Prerequisites

  • A bearer token in the Authorization header. Any endpoint that needs no token says so on its own page.
  • The id of each record the call targets. Every endpoint page lists the ids it needs.

Errors

StatusMeaning
401The bearer token is missing, expired or invalid
403The token is valid but the record sits outside your account
422The request failed validation — the response names the fields
500Unexpected server error

Individual endpoints may return more; each page lists its own.

Endpoints

Get branding

POST — See the current branding for an account or partner.

Open →

Set domain and logos

POST — Set the custom domain and upload logo and favicon.

Open →

Set colours and theme

POST — Set the colours and theme options used across the branded experience.

Open →

Set colours and theme (options + logo)

POST — Set the colours, theme options, and logo in one call.

Open →

Remove a logo or favicon

POST — Remove an uploaded logo or favicon and return to the default.

Open →

Get email sender status

POST — See whether your sending domain is verified so emails go out from your address.

Open →

Set up your email sender domain

POST — Register the domain emails should come from and get the DNS records to verify it.

Open →


Did this page help you?