PUT api/partner/whitelabel

Updates the White Label settings for the partner. Any data not passed will be understood as a desire to remove the existing data in that property.

Request Information

Authentication Method

Sub Partner Authentication

URI Parameters

None.

Body Parameters

White Label Settings (Update)
NameDescriptionTypeAdditional 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 150px. 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 exceed 200px.

 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 (Update)

 
platformPlugins

List of URLs for retrieving plugins for given platforms

 Collection of Partner Plugin (Update)

 

Request Formats

application/json, text/json

Sample: 
{
  "headerBgColor": "cccccc",
  "headerTextColor": "000000",
  "headerLogoUrl": "https://www.partner.com/resources/sw-wl-logo.png",
  "topBarBgColor": null,
  "topBarTextColor": null,
  "supportPhone": "800-555-0001",
  "supportEmail": "support@partner.com",
  "supportUrl": "https://support.partner.com",
  "mobileAppSplashScreenColor": "ffffff",
  "mobileAppPrimaryColor": "cccccc",
  "mobileAppPrimaryTextColor": "000000",
  "mobileAppSecondaryColor": "222222",
  "mobileAppSecondaryTextColor": "000000",
  "mobileAppLogoUrl": "https://www.partner.com/resources/sw-wl-logo-mobile.png",
  "features": [
    "SEM",
    "Analytics"
  ],
  "uiSettings": null,
  "partnerActions": [
    {
      "destinationType": "Message",
      "actionType": "DisplayBudget",
      "data": "display/[CAMPAIGN_ID]/modify"
    },
    {
      "destinationType": "Message",
      "actionType": "DisplayPurchase",
      "data": "display/[CAMPAIGN_ID]/purchase"
    },
    {
      "destinationType": "Message",
      "actionType": "DisplayCancel",
      "data": "display/[CAMPAIGN_ID]/cancel"
    },
    {
      "destinationType": "Message",
      "actionType": "DisplayReinstate",
      "data": "display/[CAMPAIGN_ID]/reinstate"
    }
  ],
  "platformPlugins": [
    {
      "platform": "WordPress",
      "url": "https://partner.com/plugin/wordpress"
    }
  ]
}

application/xml, text/xml

Sample: 
<WhiteLabelSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.UpdateModels">
  <features xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>SEM</d2p1:string>
    <d2p1:string>Analytics</d2p1:string>
  </features>
  <headerBgColor>cccccc</headerBgColor>
  <headerLogoUrl>https://www.partner.com/resources/sw-wl-logo.png</headerLogoUrl>
  <headerTextColor>000000</headerTextColor>
  <mobileAppLogoUrl>https://www.partner.com/resources/sw-wl-logo-mobile.png</mobileAppLogoUrl>
  <mobileAppPrimaryColor>cccccc</mobileAppPrimaryColor>
  <mobileAppPrimaryTextColor>000000</mobileAppPrimaryTextColor>
  <mobileAppSecondaryColor>222222</mobileAppSecondaryColor>
  <mobileAppSecondaryTextColor>000000</mobileAppSecondaryTextColor>
  <mobileAppSplashScreenColor>ffffff</mobileAppSplashScreenColor>
  <partnerActions>
    <PartnerAction>
      <actionType xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models">DisplayBudget</actionType>
      <data xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models">display/[CAMPAIGN_ID]/modify</data>
      <destinationType xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">Message</destinationType>
    </PartnerAction>
    <PartnerAction>
      <actionType xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models">DisplayPurchase</actionType>
      <data xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models">display/[CAMPAIGN_ID]/purchase</data>
      <destinationType xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">Message</destinationType>
    </PartnerAction>
    <PartnerAction>
      <actionType xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models">DisplayCancel</actionType>
      <data xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models">display/[CAMPAIGN_ID]/cancel</data>
      <destinationType xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">Message</destinationType>
    </PartnerAction>
    <PartnerAction>
      <actionType xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models">DisplayReinstate</actionType>
      <data xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models">display/[CAMPAIGN_ID]/reinstate</data>
      <destinationType xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">Message</destinationType>
    </PartnerAction>
  </partnerActions>
  <platformPlugins>
    <PartnerPlugin>
      <platform xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">WordPress</platform>
      <url xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DTOBaseModels">https://partner.com/plugin/wordpress</url>
    </PartnerPlugin>
  </platformPlugins>
  <supportEmail>support@partner.com</supportEmail>
  <supportPhone>800-555-0001</supportPhone>
  <supportUrl>https://support.partner.com</supportUrl>
  <topBarBgColor i:nil="true" />
  <topBarTextColor i:nil="true" />
  <uiSettings xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
</WhiteLabelSettings>

Response Information

Successful Response:

Resource Description

White Label Settings
NameDescriptionTypeAdditional information
headerBgColor

Color, in HEX, of the white label site header background.

 string

 
headerTextColor

Color, in HEX, of the white label site header text.

 string

 
headerLogoUrl

Url of the logo being displayed in the header.

 string

 
topBarBgColor

/// Color, in HEX, of the white label site top bar background.

 string

 
topBarTextColor

Color, in HEX, of the white label site top bar text.

 string

 
supportPhone

Support phone number that will appear on the white label site

 string

 
supportEmail

Support email address that will be used for support requests on the white label site

 string

 
supportUrl

Support website that will appear on the white label site

 string

 
mobileAppSplashScreenColor

Background color, in HEX, of the Splash screen of the mobile app (initial screen with logo).

 string

 
mobileAppPrimaryColor

Background color, in HEX, of the major parts of the mobile app (e.g. Section headers).

 string

 
mobileAppPrimaryTextColor

Text color, in HEX, of the major parts of the mobile app (e.g. Section header text).

 string

 
mobileAppSecondaryColor

Future Expansion

 string

 
mobileAppSecondaryTextColor

Future Expansion

 string

 
mobileAppLogoUrl

Url of the logo that is displayed on the splash page of the Mobile App.

 string

 
features

List of offerings currently enabled in the white label site.

 Collection of string

 
uiSettings

List of UI settings currently enabled in the white label site.

 Collection of string

 
partnerActions

List of Urls for WhiteLabel to redirect to based on UrlType (SEM Purchase, SEM Budget, Display Purchase, etc)

 Collection of PartnerAction

 
platformPlugins

List of URLs for retrieving plugins for given platforms

 Collection of Partner Plugin

 

Response Formats

application/json, text/json

Sample: 
{
  "headerBgColor": "cccccc",
  "headerTextColor": "000000",
  "headerLogoUrl": "https://www.partner.com/resources/sw-wl-logo.png",
  "topBarBgColor": null,
  "topBarTextColor": null,
  "supportPhone": "800-555-0001",
  "supportEmail": "support@partner.com",
  "supportUrl": "https://support.partner.com",
  "mobileAppSplashScreenColor": "ffffff",
  "mobileAppPrimaryColor": "cccccc",
  "mobileAppPrimaryTextColor": "000000",
  "mobileAppSecondaryColor": "222222",
  "mobileAppSecondaryTextColor": "000000",
  "mobileAppLogoUrl": "https://www.partner.com/resources/sw-wl-logo-mobile.png",
  "features": [
    "SEM",
    "Analytics"
  ],
  "uiSettings": null,
  "partnerActions": [
    {
      "actionType": "DisplayBudget",
      "data": "display/[CAMPAIGN_ID]/modify"
    },
    {
      "actionType": "DisplayPurchase",
      "data": "display/[CAMPAIGN_ID]/purchase"
    },
    {
      "actionType": "DisplayCancel",
      "data": "display/[CAMPAIGN_ID]/cancel"
    },
    {
      "actionType": "DisplayReinstate",
      "data": "display/[CAMPAIGN_ID]/reinstate"
    }
  ],
  "platformPlugins": [
    {
      "platform": "WordPress",
      "url": "https://partner.com/plugin/wordpress"
    }
  ]
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Type 'SiteWit.PartnerAPI.Models.ReturnModels.PartnerAction' with data contract name 'PartnerAction:http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.ReturnModels' is not expected. Consider using a DataContractResolver if you are using DataContractSerializer or add any types not known statically to the list of known types - for example, by using the KnownTypeAttribute attribute or by adding them to the list of known types passed to the serializer.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'SiteWit.PartnerAPI.Models.ReturnModels.PartnerAction' with data contract name 'PartnerAction:http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.ReturnModels' is not expected. Consider using a DataContractResolver if you are using DataContractSerializer or add any types not known statically to the list of known types - for example, by using the KnownTypeAttribute attribute or by adding them to the list of known types passed to the serializer.