Skip to content

BrandingController API Documentation

Jump to bottom
Lee Sambridge edited this page Dec 2, 2025 · 2 revisions

Branding API Documentation

This document provides documentation for the Branding API endpoints available in the Points.Api system.

Table of Contents

Authentication

All endpoints in this API require JWT Bearer authentication. Include a valid JWT token in the Authorization header of your requests.

Authorization: Bearer {your_jwt_token}

Endpoints

Get Branding Points

Retrieves branding points information for a specific partner.

URL: /api/Branding/Partner/{partnerId}/points

Method: GET

Auth required: Yes (JWT Bearer)

URL Parameters:

  • partnerId (long) - The ID of the partner

Success Response:

Example Request:

GET /api/Branding/Partner/123/points HTTP/1.1
Host: your-api-domain.com
Authorization: Bearer {your_jwt_token}

Example Response:

{
  "brandingButtonTextColor": "#FFFFFF",
  "brandingCategoriesLabel": "Categories",
  "brandingFooterBack": "#000000",
  "brandingFooterTextColor": "#FFFFFF",
  "brandingHotOffersLabel": "Hot Offers",
  "brandingLifestyleRewardsLabel": "Lifestyle Rewards",
  "brandingLifestyleRewardsUrl": "https://example.com/rewards",
  "brandingLockRewardIcon": "#FF0000",
  "brandingLoginBkgrdImageUrl": "https://example.com/images/login-bg.jpg",
  "brandingLoginBkgrdImageUrlApp": "https://example.com/images/login-bg-app.jpg",
  "brandingLoginBkgrdImageUrlM": "https://example.com/images/login-bg-m.jpg",
  "brandingLoginCaptionText": "Welcome to our rewards program",
  "brandingMluButtonBack": "#0000FF",
  "brandingMluButtonLabel": "Learn More",
  "brandingMluButtonText": "#FFFFFF",
  "brandingMluCurrentLevelBack": "#00FF00",
  "brandingMluCurrentLevelText": "#000000",
  "brandingMobilePrimaryColor": "#FF5500",
  "brandingMobilePrimaryColorBkgrd": "#FFAA00",
  "brandingMobileSecondaryColor": "#00AAFF",
  "brandingMobileSecondaryColorBkgrd": "#0055AA",
  "brandingNewRewardOverlayBackground": "#FFFF00",
  "brandingNewRewardOverlayTextColor": "#000000",
  "brandingShowPoweredBy": true,
  "brandingViewAllTextColor": "#0000FF",
  "brandingVpBackground": "#CCCCCC",
  "categoryBandTextColor": "#000000",
  "colorscheme": "light",
  "emailAddressFrom": "rewards@example.com",
  "faviconUrl": "https://example.com/favicon.ico",
  "footerCopyright": "© 2025 Example Company",
  "footerCopyrightLink": "https://example.com/copyright",
  "localizeApiKey": "api-key-123",
  "logoUrl": "https://example.com/logo.png",
  "menuFontSize": "16px",
  "menuItems": [
    {
      "id": 1,
      "name": "Home",
      "url": "/home",
      "order": 1,
      "isActive": true
    }
  ],
  "menuTextColor": "#333333",
  "partnerLinks": [
    {
      "socialSoftwareName": "Twitter",
      "socialSoftwareUrl": "https://twitter.com/example"
    }
  ],
  "partnerName": "Example Partner",
  "partnerTheme": "blue",
  "socialFacebook": "https://facebook.com/example",
  "socialInstagram": "https://instagram.com/example",
  "socialLinkedIn": "https://linkedin.com/company/example",
  "socialTiktok": "https://tiktok.com/@example",
  "socialTwitter": "https://twitter.com/example",
  "socialYoutube": "https://youtube.com/example",
  "whiteLabelHeaderColor": "#FFFFFF",
  "whiteLabelShowJoinNow": true
}

Get Partner Branding

Retrieves branding information for a specific partner and user.

URL: /api/Branding/Partner/{partnerId}/{userId}

Method: GET

Auth required: Yes (JWT Bearer)

URL Parameters:

  • partnerId (long) - The ID of the partner
  • userId (long) - The ID of the user

Success Response:

Example Request:

GET /api/Branding/Partner/123/456 HTTP/1.1
Host: your-api-domain.com
Authorization: Bearer {your_jwt_token}

Example Response:

{
  "brandingButtonTextColor": "#FFFFFF",
  "brandingCategoriesLabel": "Categories",
  "brandingFooterBack": "#000000",
  "brandingFooterTextColor": "#FFFFFF",
  "brandingHotOffersLabel": "Hot Offers",
  "brandingLifestyleRewardsLabel": "Lifestyle Rewards",
  "brandingLifestyleRewardsUrl": "https://example.com/rewards",
  "brandingLockRewardIcon": "#FF0000",
  "brandingLoginBkgrdImageUrl": "https://example.com/images/login-bg.jpg",
  "brandingLoginBkgrdImageUrlApp": "https://example.com/images/login-bg-app.jpg",
  "brandingLoginBkgrdImageUrlM": "https://example.com/images/login-bg-m.jpg",
  "brandingLoginCaptionText": "Welcome to our rewards program",
  "brandingMluButtonBack": "#0000FF",
  "brandingMluButtonLabel": "Learn More",
  "brandingMluButtonText": "#FFFFFF",
  "brandingMluCurrentLevelBack": "#00FF00",
  "brandingMluCurrentLevelText": "#000000",
  "brandingMobilePrimaryColor": "#FF5500",
  "brandingMobilePrimaryColorBkgrd": "#FFAA00",
  "brandingMobileSecondaryColor": "#00AAFF",
  "brandingMobileSecondaryColorBkgrd": "#0055AA",
  "brandingNewRewardOverlayBackground": "#FFFF00",
  "brandingNewRewardOverlayTextColor": "#000000",
  "brandingShowPoweredBy": true,
  "brandingViewAllTextColor": "#0000FF",
  "brandingVpBackground": "#CCCCCC",
  "categoryBandTextColor": "#000000",
  "colorscheme": "light",
  "emailAddressFrom": "rewards@example.com",
  "faviconUrl": "https://example.com/favicon.ico",
  "footerCopyright": "© 2025 Example Company",
  "footerCopyrightLink": "https://example.com/copyright",
  "localizeApiKey": "api-key-123",
  "logoUrl": "https://example.com/logo.png",
  "menuFontSize": "16px",
  "menuItems": [
    {
      "id": 1,
      "name": "Home",
      "url": "/home",
      "order": 1,
      "isActive": true
    }
  ],
  "menuTextColor": "#333333",
  "partnerLinks": [
    {
      "socialSoftwareName": "Twitter",
      "socialSoftwareUrl": "https://twitter.com/example"
    }
  ],
  "partnerName": "Example Partner",
  "partnerTheme": "blue",
  "socialFacebook": "https://facebook.com/example",
  "socialInstagram": "https://instagram.com/example",
  "socialLinkedIn": "https://linkedin.com/company/example",
  "socialTiktok": "https://tiktok.com/@example",
  "socialTwitter": "https://twitter.com/example",
  "socialYoutube": "https://youtube.com/example",
  "whiteLabelHeaderColor": "#FFFFFF",
  "whiteLabelShowJoinNow": true
}

Get Partner Side Branding

Retrieves side branding information for a specific partner and user.

URL: /api/Branding/Partner/{partnerId}/sidebar/{userId}

Method: GET

Auth required: Yes (JWT Bearer)

URL Parameters:

  • partnerId (long) - The ID of the partner
  • userId (long) - The ID of the user

Success Response:

  • Code: 200 OK
  • Content: BrandingSideBar object

Example Request:

GET /api/Branding/Partner/123/sidebar/456 HTTP/1.1
Host: your-api-domain.com
Authorization: Bearer {your_jwt_token}

Example Response:

{
  "id": 1,
  "partnerId": 123,
  "sideMenuItems": [
    {
      "id": 1,
      "name": "Dashboard",
      "url": "/dashboard",
      "order": 1,
      "isActive": true,
      "hasNotification": false
    },
    {
      "id": 2,
      "name": "Rewards",
      "url": "/rewards",
      "order": 2,
      "isActive": true,
      "hasNotification": true
    }
  ]
}

Get Partner Branding Menu Items

Retrieves menu items for a specific partner's branding.

URL: /api/Branding/Partner/{partnerId}/menuitems

Method: GET

Auth required: Yes (JWT Bearer)

URL Parameters:

  • partnerId (long) - The ID of the partner

Success Response:

  • Code: 200 OK
  • Content: Array of PartnerMenuItems objects

Example Request:

GET /api/Branding/Partner/123/menuitems HTTP/1.1
Host: your-api-domain.com
Authorization: Bearer {your_jwt_token}

Example Response:

[
  {
    "id": 1,
    "name": "Home",
    "url": "/home",
    "order": 1,
    "isActive": true
  },
  {
    "id": 2,
    "name": "Rewards",
    "url": "/rewards",
    "order": 2,
    "isActive": true
  },
  {
    "id": 3,
    "name": "Profile",
    "url": "/profile",
    "order": 3,
    "isActive": true
  }
]

Send Brand Suggestion

Sends a brand suggestion to the system.

URL: /api/Branding/brandrequest

Method: PUT

Auth required: Yes (JWT Bearer)

Request Body:

Success Response:

  • Code: 200 OK
  • Content: Empty response

Example Request:

PUT /api/Branding/brandrequest HTTP/1.1
Host: your-api-domain.com
Authorization: Bearer {your_jwt_token}
Content-Type: application/json

{
  "brand": "Example Brand",
  "mid": 456,
  "pid": 123
}

Example Response:

{}

Models

Branding

The Branding model contains all branding-related information for a partner.

Property Type Description
brandingButtonTextColor string Color code for button text
brandingCategoriesLabel string Label for categories section
brandingFooterBack string Background color for footer
brandingFooterTextColor string Text color for footer
brandingHotOffersLabel string Label for hot offers section
brandingLifestyleRewardsLabel string Label for lifestyle rewards section
brandingLifestyleRewardsUrl string URL for lifestyle rewards
brandingLockRewardIcon string Color code for lock reward icon
brandingLoginBkgrdImageUrl string Background image URL for login page
brandingLoginBkgrdImageUrlApp string Background image URL for login page in app
brandingLoginBkgrdImageUrlM string Background image URL for login page on mobile
brandingLoginCaptionText string Caption text for login page
brandingMluButtonBack string Background color for MLU button
brandingMluButtonLabel string Label for MLU button
brandingMluButtonText string Text color for MLU button
brandingMluCurrentLevelBack string Background color for current level in MLU
brandingMluCurrentLevelText string Text color for current level in MLU
brandingMobilePrimaryColor string Primary color for mobile
brandingMobilePrimaryColorBkgrd string Primary background color for mobile
brandingMobileSecondaryColor string Secondary color for mobile
brandingMobileSecondaryColorBkgrd string Secondary background color for mobile
brandingNewRewardOverlayBackground string Background color for new reward overlay
brandingNewRewardOverlayTextColor string Text color for new reward overlay
brandingShowPoweredBy boolean Whether to show "Powered By" text
brandingViewAllTextColor string Text color for "View All" links
brandingVpBackground string Background color for VP section
categoryBandTextColor string Text color for category band
colorscheme string Color scheme for the branding
emailAddressFrom string Email address used for "From" field
faviconUrl string URL for favicon
footerCopyright string Copyright text for footer
footerCopyrightLink string Link for copyright text
localizeApiKey string API key for localization service
logoUrl string URL for logo
menuFontSize string Font size for menu
menuItems array List of menu items
menuTextColor string Text color for menu
partnerLinks array List of partner links
partnerName string Name of the partner
partnerTheme string Theme for the partner
socialFacebook string Facebook URL
socialInstagram string Instagram URL
socialLinkedIn string LinkedIn URL
socialTiktok string TikTok URL
socialTwitter string Twitter URL
socialYoutube string YouTube URL
whiteLabelHeaderColor string Header color for white label
whiteLabelShowJoinNow boolean Whether to show "Join Now" button

BrandingSideBar

The BrandingSideBar model contains information about the sidebar branding.

Property Type Description
id integer Unique identifier for the sidebar branding
partnerId integer ID of the partner
sideMenuItems array List of sidebar menu items

PartnerMenuItems

The PartnerMenuItems model represents a menu item in the partner's branding.

Property Type Description
id integer Unique identifier for the menu item
name string Display name of the menu item
url string URL the menu item links to
order integer Order of the menu item in the list
isActive boolean Whether the menu item is active

BrandRequestModel

The BrandRequestRequest model is used to send brand suggestions.

Property Type Description
brand string Name of the brand being suggested
mid integer Member ID
pid integer Partner ID

PartnerLinks

The PartnerLinks model represents links associated with a partner.

Property Type Description
socialSoftwareName string Name of the social software or platform
socialSoftwareUrl string URL for the social software or platform

Terms and Conditions | Privacy Policy | Acceptable Use Policy | Cookie Policy

Clone this wiki locally