The branding API controls the appearance of proxy-generated error pages (404, 502, gateway timeout) served within your custom preview domain. Set your logo, product name, support URL, and primary accent color so end-users see your brand - not MIOSA’s.
Base path: /api/v1/tenant/branding
Endpoints
| Method | Path | Description |
|---|---|---|
GET | /api/v1/tenant/branding | Get current branding |
PUT | /api/v1/tenant/branding | Set or replace branding |
DELETE | /api/v1/tenant/branding | Reset to MIOSA defaults |
Get Branding
GET /api/v1/tenant/branding
Auth
Authorization: Bearer msk_...Response - 200 OK
{
"branding": {
"logo_url": "https://cdn.cliniciq.com/logo.png",
"name": "ClinicIQ",
"support_url": "https://cliniciq.com/support",
"primary_color": "#0066FF"
}
}Returns {"branding": null} if no custom branding has been set.
Set Branding
PUT /api/v1/tenant/branding
Replaces all branding fields. Omitted fields are cleared to their defaults.
Request Body
Wrap fields under a "branding" key.
| Field | Type | Required | Description |
|---|---|---|---|
logo_url | string | No | HTTPS URL to your logo image |
name | string | No | Product or company name |
support_url | string | No | Link shown on error pages for user support |
primary_color | string | No | Hex color for CTA buttons (e.g. "#0066FF") |
{
"branding": {
"logo_url": "https://cdn.cliniciq.com/logo.png",
"name": "ClinicIQ",
"support_url": "https://cliniciq.com/support",
"primary_color": "#0066FF"
}
}Response - 200 OK
{
"branding": {
"logo_url": "https://cdn.cliniciq.com/logo.png",
"name": "ClinicIQ",
"support_url": "https://cliniciq.com/support",
"primary_color": "#0066FF"
}
}Delete Branding
DELETE /api/v1/tenant/branding
Resets all branding to MIOSA defaults. Error pages will show the MIOSA logo and color scheme.
Response - 200 OK
{
"branding": null
}Errors
| Status | Code | Cause |
|---|---|---|
| 404 | tenant not found | Tenant does not exist |
| 422 | validation error | A field failed validation (e.g. invalid URL, invalid hex color) |