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.
Prerequisites
- A bearer token in the
Authorizationheader. 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
| Status | Meaning |
|---|---|
401 | The bearer token is missing, expired or invalid |
403 | The token is valid but the record sits outside your account |
422 | The request failed validation — the response names the fields |
500 | Unexpected server error |
Individual endpoints may return more; each page lists its own.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
POST | White Label - Resolve branding (public/login) | Resolve white-label branding (logo, login logo, favicon, title, white-label URL, status) and saved theme options for a company so the sign-in screen can be branded before authentication. |
POST | White Label - Get data (data resolver) | Resolve the white-label branding/domain config for a company — looked up by explicit company_id, by referral_code (resolved to its company), or, if neither is given, inferred from the request Referer host (subdomain + domain matched against domain_prefix/domain_name). |
POST | Get branding | Returns the authenticated user's white-label configuration row (logos, favicon, domain prefix/name, sub-domain verification status), theme settings, and the email-templates-enabled flag for editing in the partner UI. |
POST | Set domain and logos | Sets up or updates your own account's white-label branding: the custom subdomain, the display title, and up to four account images. |
POST | Set colours and theme | Save the theme options for one account, and optionally uploads a theme logo at the same time. |
POST | Remove a logo or favicon | Remove one branding image from a company's white-label config by nulling the matching column (favicon, logo, login_logo, or mobile_logo) on the latest RsWhiteLabel row and saving. |
POST | Get email sender status | Returns the company's email white-label record plus live domain verification status. |
POST | Set up your email sender domain | Create or updates the email white-label sender for a company and verifies its domain. |
POST | Set colours and theme (options + logo) | Create or updates the latest RsUserThemeSetting for a company (recording the authenticated user as author) with the supplied theme_options JSON, and — when a logo_image file is sent — stores it to S3 and writes it onto the company's RsWhiteLabel logo. |