White-label API Guide

This guide covers how to use the White-label API to customize branding on either:

• The whole instance (group of companies), or
• A specific company

Instance-wide Branding (or for Group of Companies)

These endpoints apply branding changes across the entire instance or a group of managed companies, based on the logged-in user's scope of rights.

1. Upload Light Logo

Company logo displayed in the menu while in light mode.

Endpoint: POST /wep/brand/logo View Docs

Payload:

logo: (file)

2. Upload Dark Logo

Company logo displayed in the menu while in dark mode.

Endpoint: POST /wep/brand/logo-dark View Docs

Payload:

logo: (file)

3. Set App Name

Endpoint: POST /wep/brand/app-name View Docs

Payload:

{
  "data": "Your Custom App Name"
}

4. Set Support Email

Endpoint: POST /wep/brand/supportemail View Docs

Payload:

{
  "data": "[email protected]"
}

5. Set Support Phone

Endpoint: POST /wep/brand/supportphone View Docs

Payload:

{
  "data": "+18005551234"
}

6. Set Custom Colors

Colors customize the application's appearance.

Endpoint: POST /wep/brand/custom-colors View Docs

Example Payload:

{
  "data": {
    "skin": "custom",
    "primary": "#5b5fc7",
    "menuColor": "#151552",
    "backgroundColor":"white",
    "avatar":["#f76707","#37b24d", "#1c7ed6", "#d6336c", "#ae3ec9"]
  }
}

Company-specific Branding

Use these endpoints to customize branding for a specific company by companyId.

1. Upload Light Logo

Endpoint: POST /wep/companies/{companyId}/brand/logo View Docs

2. Upload Dark Logo

Endpoint: POST /wep/companies/{companyId}/brand/logo-dark View Docs

3. Set App Name

Endpoint: POST /wep/companies/{companyId}/brand/app-name View Docs

4. Set Custom Colors

Endpoint: POST /wep/companies/{companyId}/brand/custom-colors View Docs

📘

Notes

• All logo endpoints use multipart/form-data and expect a file upload.
• skin should be set to "custom" if using custom colors.
• Instance-wide settings may be overridden at the company level.