POST api/Agency/UpdateBrandingSettings

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
AgencyId	string	Required
AdminUserId	string	Required
IsBrandingEnabled	boolean	None.
DomainPart	string	Required
SubDomainPart	string	Required
IsSubDomain	boolean	Required
FullDomain	string	None.
LogoURL	string	Required
BackgroundColor	Color	Required
ForegroundColor	Color	Required
HoverColor	Color	Required
PoweredbyMindMe	boolean	None.
IOSAppAllowed	boolean	None.
AndroidAppAllowed	boolean	None.
SocialLinks	AgencySocialLinksResponseVM	None.
FooterLogoURL	string	None.
BackgroundColorHex	string	None.
ForegroundColorHex	string	None.
SmallLogoURL	string	None.
FooterType	AgencyFooterType	Required
IOSAppStoreURL	string	None.
AndroidAppStoreURL	string	None.
Terms	AgencyTermsSettingsVM	None.
SystemTerms	AgencyTermsSettingsVM	None.
ButtonBackgroundColor	Color	Required
ButtonForegroundColor	Color	Required
ButtonHoverColor	Color	Required
ButtonBackgroundColorHex	string	None.
ButtonForegroundColorHex	string	None.
ButtonHoverColorHex	string	None.
EmailFooterAboutUs	string	None.

Request Formats

application/json, text/json

Sample:

{
  "AgencyId": "sample string 1",
  "AdminUserId": "sample string 2",
  "IsBrandingEnabled": true,
  "DomainPart": "sample string 4",
  "SubDomainPart": "sample string 5",
  "IsSubDomain": true,
  "FullDomain": "sample string 5.sample string 4",
  "LogoURL": "sample string 7",
  "BackgroundColor": {
    "HexValue": "sample string 1",
    "RgbValue": {
      "R": "sample string 1",
      "G": "sample string 2",
      "B": "sample string 3",
      "A": "sample string 4"
    },
    "Gradient": "sample string 2"
  },
  "ForegroundColor": {
    "HexValue": "sample string 1",
    "RgbValue": {
      "R": "sample string 1",
      "G": "sample string 2",
      "B": "sample string 3",
      "A": "sample string 4"
    },
    "Gradient": "sample string 2"
  },
  "HoverColor": {
    "HexValue": "sample string 1",
    "RgbValue": {
      "R": "sample string 1",
      "G": "sample string 2",
      "B": "sample string 3",
      "A": "sample string 4"
    },
    "Gradient": "sample string 2"
  },
  "PoweredbyMindMe": true,
  "IOSAppAllowed": true,
  "AndroidAppAllowed": true,
  "SocialLinks": {
    "FacebookURL": "sample string 1",
    "TwitterURL": "sample string 2",
    "LinkedInURL": "sample string 3"
  },
  "FooterLogoURL": "sample string 11",
  "BackgroundColorHex": "sample string 12",
  "ForegroundColorHex": "sample string 13",
  "SmallLogoURL": "sample string 14",
  "FooterType": "None",
  "IOSAppStoreURL": "sample string 15",
  "AndroidAppStoreURL": "sample string 16",
  "Terms": {
    "IsCustom": true,
    "MobileTermsURL": "sample string 2",
    "TermsAndConditionsURL": "sample string 3",
    "PrivacyPolicyURL": "sample string 4",
    "LegalRights": "sample string 5",
    "ShowMobileTermsURL": true,
    "ShowTermsAndConditionsURL": true,
    "ShowPrivacyPolicyURL": true,
    "ShowLegalRights": true
  },
  "SystemTerms": {
    "IsCustom": true,
    "MobileTermsURL": "sample string 2",
    "TermsAndConditionsURL": "sample string 3",
    "PrivacyPolicyURL": "sample string 4",
    "LegalRights": "sample string 5",
    "ShowMobileTermsURL": true,
    "ShowTermsAndConditionsURL": true,
    "ShowPrivacyPolicyURL": true,
    "ShowLegalRights": true
  },
  "ButtonBackgroundColor": {
    "HexValue": "sample string 1",
    "RgbValue": {
      "R": "sample string 1",
      "G": "sample string 2",
      "B": "sample string 3",
      "A": "sample string 4"
    },
    "Gradient": "sample string 2"
  },
  "ButtonForegroundColor": {
    "HexValue": "sample string 1",
    "RgbValue": {
      "R": "sample string 1",
      "G": "sample string 2",
      "B": "sample string 3",
      "A": "sample string 4"
    },
    "Gradient": "sample string 2"
  },
  "ButtonHoverColor": {
    "HexValue": "sample string 1",
    "RgbValue": {
      "R": "sample string 1",
      "G": "sample string 2",
      "B": "sample string 3",
      "A": "sample string 4"
    },
    "Gradient": "sample string 2"
  },
  "ButtonBackgroundColorHex": "sample string 17",
  "ButtonForegroundColorHex": "sample string 18",
  "ButtonHoverColorHex": "sample string 19",
  "EmailFooterAboutUs": "sample string 20"
}

application/xml, text/xml

Sample:

<UpdateAgencyBrandingSettingsRequestVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.RequestViewModels.Agency">
  <AndroidAppAllowed xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.DTO_Models.Agency">true</AndroidAppAllowed>
  <AndroidAppStoreURL xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.DTO_Models.Agency">sample string 16</AndroidAppStoreURL>
  <BackgroundColor xmlns:d2p1="http://schemas.datacontract.org/2004/07/MindMe.Shared.Models.Elements" xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.DTO_Models.Agency">
    <d2p1:Gradient>sample string 2</d2p1:Gradient>
    <d2p1:HexValue>sample string 1</d2p1:HexValue>
    <d2p1:RgbValue>
      <d2p1:A>sample string 4</d2p1:A>
      <d2p1:B>sample string 3</d2p1:B>
      <d2p1:G>sample string 2</d2p1:G>
      <d2p1:R>sample string 1</d2p1:R>
    </d2p1:RgbValue>
  </BackgroundColor>
  <BackgroundColorHex xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.DTO_Models.Agency">sample string 12</BackgroundColorHex>
  <ButtonBackgroundColor xmlns:d2p1="http://schemas.datacontract.org/2004/07/MindMe.Shared.Models.Elements" xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.DTO_Models.Agency">
    <d2p1:Gradient>sample string 2</d2p1:Gradient>
    <d2p1:HexValue>sample string 1</d2p1:HexValue>
    <d2p1:RgbValue>
      <d2p1:A>sample string 4</d2p1:A>
      <d2p1:B>sample string 3</d2p1:B>
      <d2p1:G>sample string 2</d2p1:G>
      <d2p1:R>sample string 1</d2p1:R>
    </d2p1:RgbValue>
  </ButtonBackgroundColor>
  <ButtonBackgroundColorHex xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.DTO_Models.Agency">sample string 17</ButtonBackgroundColorHex>
  <ButtonForegroundColor xmlns:d2p1="http://schemas.datacontract.org/2004/07/MindMe.Shared.Models.Elements" xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.DTO_Models.Agency">
    <d2p1:Gradient>sample string 2</d2p1:Gradient>
    <d2p1:HexValue>sample string 1</d2p1:HexValue>
    <d2p1:RgbValue>
      <d2p1:A>sample string 4</d2p1:A>
      <d2p1:B>sample string 3</d2p1:B>
      <d2p1:G>sample string 2</d2p1:G>
      <d2p1:R>sample string 1</d2p1:R>
    </d2p1:RgbValue>
  </ButtonForegroundColor>
  <ButtonForegroundColorHex xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.DTO_Models.Agency">sample string 18</ButtonForegroundColorHex>
  <ButtonHoverColor xmlns:d2p1="http://schemas.datacontract.org/2004/07/MindMe.Shared.Models.Elements" xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.DTO_Models.Agency">
    <d2p1:Gradient>sample string 2</d2p1:Gradient>
    <d2p1:HexValue>sample string 1</d2p1:HexValue>
    <d2p1:RgbValue>
      <d2p1:A>sample string 4</d2p1:A>
      <d2p1:B>sample string 3</d2p1:B>
      <d2p1:G>sample string 2</d2p1:G>
      <d2p1:R>sample string 1</d2p1:R>
    </d2p1:RgbValue>
  </ButtonHoverColor>
  <ButtonHoverColorHex xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.DTO_Models.Agency">sample string 19</ButtonHoverColorHex>
  <DomainPart xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.DTO_Models.Agency">sample string 4</DomainPart>
  <EmailFooterAboutUs xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.DTO_Models.Agency">sample string 20</EmailFooterAboutUs>
  <FooterLogoURL xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.DTO_Models.Agency">sample string 11</FooterLogoURL>
  <FooterType xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.DTO_Models.Agency">None</FooterType>
  <ForegroundColor xmlns:d2p1="http://schemas.datacontract.org/2004/07/MindMe.Shared.Models.Elements" xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.DTO_Models.Agency">
    <d2p1:Gradient>sample string 2</d2p1:Gradient>
    <d2p1:HexValue>sample string 1</d2p1:HexValue>
    <d2p1:RgbValue>
      <d2p1:A>sample string 4</d2p1:A>
      <d2p1:B>sample string 3</d2p1:B>
      <d2p1:G>sample string 2</d2p1:G>
      <d2p1:R>sample string 1</d2p1:R>
    </d2p1:RgbValue>
  </ForegroundColor>
  <ForegroundColorHex xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.DTO_Models.Agency">sample string 13</ForegroundColorHex>
  <HoverColor xmlns:d2p1="http://schemas.datacontract.org/2004/07/MindMe.Shared.Models.Elements" xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.DTO_Models.Agency">
    <d2p1:Gradient>sample string 2</d2p1:Gradient>
    <d2p1:HexValue>sample string 1</d2p1:HexValue>
    <d2p1:RgbValue>
      <d2p1:A>sample string 4</d2p1:A>
      <d2p1:B>sample string 3</d2p1:B>
      <d2p1:G>sample string 2</d2p1:G>
      <d2p1:R>sample string 1</d2p1:R>
    </d2p1:RgbValue>
  </HoverColor>
  <IOSAppAllowed xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.DTO_Models.Agency">true</IOSAppAllowed>
  <IOSAppStoreURL xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.DTO_Models.Agency">sample string 15</IOSAppStoreURL>
  <IsSubDomain xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.DTO_Models.Agency">true</IsSubDomain>
  <LogoURL xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.DTO_Models.Agency">sample string 7</LogoURL>
  <PoweredbyMindMe xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.DTO_Models.Agency">true</PoweredbyMindMe>
  <SmallLogoURL xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.DTO_Models.Agency">sample string 14</SmallLogoURL>
  <SocialLinks xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.DTO_Models.Agency">
    <FacebookURL>sample string 1</FacebookURL>
    <LinkedInURL>sample string 3</LinkedInURL>
    <TwitterURL>sample string 2</TwitterURL>
  </SocialLinks>
  <SubDomainPart xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.DTO_Models.Agency">sample string 5</SubDomainPart>
  <SystemTerms xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.DTO_Models.Agency">
    <IsCustom>true</IsCustom>
    <LegalRights>sample string 5</LegalRights>
    <MobileTermsURL>sample string 2</MobileTermsURL>
    <PrivacyPolicyURL>sample string 4</PrivacyPolicyURL>
    <ShowLegalRights>true</ShowLegalRights>
    <ShowMobileTermsURL>true</ShowMobileTermsURL>
    <ShowPrivacyPolicyURL>true</ShowPrivacyPolicyURL>
    <ShowTermsAndConditionsURL>true</ShowTermsAndConditionsURL>
    <TermsAndConditionsURL>sample string 3</TermsAndConditionsURL>
  </SystemTerms>
  <Terms xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.DTO_Models.Agency">
    <IsCustom>true</IsCustom>
    <LegalRights>sample string 5</LegalRights>
    <MobileTermsURL>sample string 2</MobileTermsURL>
    <PrivacyPolicyURL>sample string 4</PrivacyPolicyURL>
    <ShowLegalRights>true</ShowLegalRights>
    <ShowMobileTermsURL>true</ShowMobileTermsURL>
    <ShowPrivacyPolicyURL>true</ShowPrivacyPolicyURL>
    <ShowTermsAndConditionsURL>true</ShowTermsAndConditionsURL>
    <TermsAndConditionsURL>sample string 3</TermsAndConditionsURL>
  </Terms>
  <AdminUserId>sample string 2</AdminUserId>
  <AgencyId>sample string 1</AgencyId>
  <IsBrandingEnabled>true</IsBrandingEnabled>
</UpdateAgencyBrandingSettingsRequestVM>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.