| Name | Description | Type | Additional information |
|---|---|---|---|
| headerBgColor |
Desired color, in HEX, of the white label site header background. |
string |
Matching regular expression pattern: ^#?([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ |
| headerTextColor |
Desired color, in HEX, of the white label site header text. |
string |
Matching regular expression pattern: ^#?([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ |
| headerLogoUrl |
Url of the logo to display in the header. This should be a PNG file with transparent background. Height should not exceed 50px and the width should not exceed 250px. The Url should be HTTPS to avoid SSL errors. |
string |
A valid Url |
| topBarBgColor |
Desired color, in HEX, of the white label site top bar background. |
string |
Matching regular expression pattern: ^#?([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ |
| topBarTextColor |
Desired color, in HEX, of the white label site top bar text. |
string |
Matching regular expression pattern: ^#?([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ |
| supportPhone |
Partner's end user support phone number |
string |
|
| supportEmail |
Partner's end user support email address |
string |
A valid email address |
| supportUrl |
Partner's end user support url |
string |
A valid Url |
| mobileAppSplashScreenColor |
Desired background color, in HEX, of the splash screen of the mobile app. |
string |
Matching regular expression pattern: ^#?([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ |
| mobileAppPrimaryColor |
Desired background color, in HEX, of the major parts of the mobile app (e.g. Section headers). |
string |
Matching regular expression pattern: ^#?([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ |
| mobileAppPrimaryTextColor |
Desired text color, in HEX, of the major parts of the mobile app (e.g. Section header text). |
string |
Matching regular expression pattern: ^#?([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ |
| mobileAppSecondaryColor |
Future Expansion |
string |
Matching regular expression pattern: ^#?([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ |
| mobileAppSecondaryTextColor |
Future Expansion |
string |
Matching regular expression pattern: ^#?([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$ |
| mobileAppLogoUrl |
Url of the logo to display on the splash page of the Mobile App. This should be a PNG file with transparent background. Height should be at least 300px and the width should be at least 300px. |
string |
A valid Url |
| features |
List of offerings the partner wishes to utilize. SEM must be present or the action will fail. Options include "SEM" and "Analytics". |
Collection of string |
Required A list of valid Features. "SEM" must be present in the list. |
| uiSettings |
List of UI settings defining how the WL site should appear and function. |
Collection of string |
A list of valid UI Settings. (Optional) |
| partnerActions |
List of Urls for WhiteLabel to redirect to based on UrlType (SEM Purchase, SEM Budget, Display Purchase, etc) |
Collection of Partner Action (Create) |
|
| platformPlugins |
List of URLs for retrieving plugins for given platforms |
Collection of Partner Plugin (Create) |
|
