Partner ApiBranding

Branding

Update partner branding settings including logo, colors, and company name. These settings affect the white-labeled experience for your organizations.

Update Branding

Update logo, primary and secondary colors, and company name. All fields are optional; only include fields you want to change.

Request:

PUT /partner/branding

Body:

{
  "logoUrl": "https://example.com/logo.png",
  "primaryColor": "#0066cc",
  "secondaryColor": "#333333",
  "companyName": "Your Company Name"
}
FieldTypeDescription
logoUrlstringURL to your logo image (used in dashboards and emails)
primaryColorstringPrimary brand color (hex format, e.g., #0066cc)
secondaryColorstringSecondary brand color (hex format)
companyNamestringCompany name displayed to end users

Response:

{
  "partner": {
    "id": "uuid",
    "name": "Partner Name",
    "slug": "partner-slug",
    "logoUrl": "https://example.com/logo.png",
    "primaryColor": "#0066cc",
    "secondaryColor": "#333333",
    "companyName": "Your Company Name"
  }
}

Example:

curl -X PUT "https://api.app.bullseye.so/api/v1/partner/branding" 
  -H "X-Partner-API-Key: your-api-key" 
  -H "Content-Type: application/json" 
  -d '{
    "logoUrl": "https://cdn.example.com/logo.png",
    "primaryColor": "#0066cc",
    "secondaryColor": "#333333",
    "companyName": "Acme Analytics"
  }'

Branding Guidelines

  • Logo: Use a high-resolution image (minimum 200x200px). PNG or SVG recommended. Ensure the URL is publicly accessible.
  • Colors: Use hex format (#RRGGBB). Primary color is used for buttons, links, and accents. Secondary is used for text and backgrounds.
  • Company Name: This appears in the white-labeled dashboard header, emails, and support references.