POST api/v1/sitenotice

Saves the site notice.

Request Information

URI Parameters

None.

Body Parameters

The notice.

Ghostery.Privacy.Common.Objects.Site.SiteNotice

Name	Type	Additional information
Id	integer	None.
CompanyId	integer	None.
Created	date	None.
CreatedBy	Ghostery.Privacy.Common.Objects.UserModel	None.
Modified	date	None.
ModifiedBy	Ghostery.Privacy.Common.Objects.UserModel	None.
Status	integer	None.
Name	string	None.
Domain	string	None.
Domains	Collection of Ghostery.Privacy.Common.Objects.Site.DomainModel	None.
Type	string	None.
Country	Ghostery.Privacy.Common.Objects.Option.CountryModel	None.
Language	Ghostery.Privacy.Common.Objects.Option.LanguageModel	None.
ShowIcon	boolean	None.
DynamicTagPopulation	boolean	None.
SiteEncoding	string	None.
NoJavascriptCalls	boolean	None.
LinkText	string	None.
UseMobileCSS	boolean	None.
UseInlineStyles	boolean	None.
EssentialCookies	Collection of Ghostery.Privacy.Common.Objects.Site.Cookie	None.
AdvertisingCookies	Collection of Ghostery.Privacy.Common.Objects.Site.Cookie	None.
AdvertisingVendors	Collection of Ghostery.Privacy.Common.Objects.Vendor.NoticeVendorModel	None.
AnalyticsCookies	Collection of Ghostery.Privacy.Common.Objects.Site.Cookie	None.
AnalyticsVendors	Collection of Ghostery.Privacy.Common.Objects.Vendor.NoticeVendorModel	None.
OptOutOverlay	Ghostery.Privacy.Common.Objects.Site.OptOutOverlay	None.
Hover	Ghostery.Privacy.Common.Objects.Site.Hover	None.
ImpliedConsent	Ghostery.Privacy.Common.Objects.Site.ImpliedConsent	None.
ExplicitConsent	Ghostery.Privacy.Common.Objects.Site.ExplicitConsent	None.
Tag	string	None.

Request Formats

application/json, text/json

Sample:

{
  "id": 1,
  "companyId": 2,
  "created": "2025-05-14T16:12:39.9238324+00:00",
  "createdBy": {
    "id": 1,
    "companyId": 2,
    "companyName": "sample string 3",
    "email": "sample string 4",
    "name": "sample string 5",
    "password": "sample string 6",
    "hashedPassword": "sample string 7",
    "statusId": 8,
    "locked": true,
    "failedLoginCount": 10,
    "lastLogin": "2025-05-14T16:12:39.9238324+00:00",
    "loginCount": 11,
    "lastActivity": "2025-05-14T16:12:39.9238324+00:00",
    "companies": [
      {
        "userId": 1,
        "companyId": 2,
        "name": "sample string 3",
        "products": [
          1,
          2
        ],
        "permissions": [
          1,
          2
        ],
        "companyProducts": [
          1,
          2
        ]
      },
      {
        "userId": 1,
        "companyId": 2,
        "name": "sample string 3",
        "products": [
          1,
          2
        ],
        "permissions": [
          1,
          2
        ],
        "companyProducts": [
          1,
          2
        ]
      }
    ],
    "firstName": "sample string 12",
    "lastName": "sample string 13",
    "resetToken": "sample string 14",
    "resetRequested": "2025-05-14T16:12:39.9238324+00:00",
    "isCsm": true,
    "userTypeId": 17
  },
  "modified": "2025-05-14T16:12:39.9238324+00:00",
  "modifiedBy": {
    "id": 1,
    "companyId": 2,
    "companyName": "sample string 3",
    "email": "sample string 4",
    "name": "sample string 5",
    "password": "sample string 6",
    "hashedPassword": "sample string 7",
    "statusId": 8,
    "locked": true,
    "failedLoginCount": 10,
    "lastLogin": "2025-05-14T16:12:39.9238324+00:00",
    "loginCount": 11,
    "lastActivity": "2025-05-14T16:12:39.9238324+00:00",
    "companies": [
      {
        "userId": 1,
        "companyId": 2,
        "name": "sample string 3",
        "products": [
          1,
          2
        ],
        "permissions": [
          1,
          2
        ],
        "companyProducts": [
          1,
          2
        ]
      },
      {
        "userId": 1,
        "companyId": 2,
        "name": "sample string 3",
        "products": [
          1,
          2
        ],
        "permissions": [
          1,
          2
        ],
        "companyProducts": [
          1,
          2
        ]
      }
    ],
    "firstName": "sample string 12",
    "lastName": "sample string 13",
    "resetToken": "sample string 14",
    "resetRequested": "2025-05-14T16:12:39.9238324+00:00",
    "isCsm": true,
    "userTypeId": 17
  },
  "status": 5,
  "name": "sample string 6",
  "domain": "sample string 7",
  "domains": [
    {
      "id": 1,
      "url": "sample string 2"
    },
    {
      "id": 1,
      "url": "sample string 2"
    }
  ],
  "type": "sample string 8",
  "country": {
    "id": 1,
    "name": "sample string 2",
    "code": "sample string 3",
    "languages": [
      {
        "id": 1,
        "name": "sample string 2",
        "code": "sample string 3"
      },
      {
        "id": 1,
        "name": "sample string 2",
        "code": "sample string 3"
      }
    ],
    "defaultLanguageId": 4
  },
  "language": {
    "id": 1,
    "name": "sample string 2",
    "code": "sample string 3"
  },
  "showIcon": true,
  "dynamicTagPopulation": true,
  "siteEncoding": "sample string 11",
  "noJavascriptCalls": true,
  "linkText": "sample string 13",
  "useMobileCSS": true,
  "useInlineStyles": true,
  "essentialCookies": [
    {
      "name": "sample string 1",
      "purpose": "sample string 2",
      "optOutUrl": "sample string 3",
      "directOptOut": true
    },
    {
      "name": "sample string 1",
      "purpose": "sample string 2",
      "optOutUrl": "sample string 3",
      "directOptOut": true
    }
  ],
  "advertisingCookies": [
    {
      "name": "sample string 1",
      "purpose": "sample string 2",
      "optOutUrl": "sample string 3",
      "directOptOut": true
    },
    {
      "name": "sample string 1",
      "purpose": "sample string 2",
      "optOutUrl": "sample string 3",
      "directOptOut": true
    }
  ],
  "advertisingVendors": [
    {
      "id": 1,
      "name": "sample string 2",
      "category": "sample string 3",
      "logoUrl": "sample string 4",
      "description": "sample string 5",
      "privacyUrl": "sample string 6",
      "essential": true
    },
    {
      "id": 1,
      "name": "sample string 2",
      "category": "sample string 3",
      "logoUrl": "sample string 4",
      "description": "sample string 5",
      "privacyUrl": "sample string 6",
      "essential": true
    }
  ],
  "analyticsCookies": [
    {
      "name": "sample string 1",
      "purpose": "sample string 2",
      "optOutUrl": "sample string 3",
      "directOptOut": true
    },
    {
      "name": "sample string 1",
      "purpose": "sample string 2",
      "optOutUrl": "sample string 3",
      "directOptOut": true
    }
  ],
  "analyticsVendors": [
    {
      "id": 1,
      "name": "sample string 2",
      "category": "sample string 3",
      "logoUrl": "sample string 4",
      "description": "sample string 5",
      "privacyUrl": "sample string 6",
      "essential": true
    },
    {
      "id": 1,
      "name": "sample string 2",
      "category": "sample string 3",
      "logoUrl": "sample string 4",
      "description": "sample string 5",
      "privacyUrl": "sample string 6",
      "essential": true
    }
  ],
  "optOutOverlay": {
    "header": "sample string 1",
    "logo": "sample string 2",
    "message": "sample string 3",
    "showWhatHappensLink": true,
    "showSelfRegulatoryLink": true,
    "showMoreVendorsLink": true,
    "showGhosteryLink": true,
    "headerFontSize": 8,
    "buttonColor": "sample string 9",
    "hyperlinkColor": "sample string 10",
    "logoImage": "QEA=",
    "logoImageType": "sample string 11"
  },
  "hover": {
    "position": "sample string 1",
    "hoverButtonText": "sample string 2",
    "hoverButtonFont": {
      "name": "sample string 1",
      "size": 2,
      "color": "sample string 3"
    },
    "buttonIcon": "sample string 3",
    "buttonCss": "sample string 4"
  },
  "impliedConsent": {
    "displayFrequency": 1,
    "maxPerSession": 2,
    "fadeNotice": true,
    "fadeSeconds": 4,
    "cookieOnSubDomain": true,
    "banner": {
      "customText": true,
      "showInfoIcon": true,
      "infoButtonImage": "sample string 3",
      "infoIconCss": "sample string 4",
      "title": "sample string 5",
      "message": "sample string 6",
      "defaultMessage": "sample string 7",
      "cookieMessage": "sample string 8",
      "urlMarker": "sample string 9",
      "learnMoreMessage": "sample string 10",
      "includeCookieNotice": true,
      "cookieNoticeUrl": "sample string 12",
      "titleFont": {
        "name": "sample string 1",
        "size": 2,
        "color": "sample string 3"
      },
      "titleCss": "sample string 13",
      "messageFont": {
        "name": "sample string 1",
        "size": 2,
        "color": "sample string 3"
      },
      "messageCss": "sample string 14",
      "bannerColor": "sample string 15",
      "width": 16,
      "position": "sample string 17",
      "verticalOffset": 18,
      "roundedCorners": true,
      "opacity": 20,
      "borderColor": "sample string 21",
      "borderWidth": "sample string 22",
      "bannerCss": "sample string 23",
      "cookieOnSubDomain": true,
      "showAcceptButton": true,
      "acceptButtonText": "sample string 26",
      "acceptButtonCss": "sample string 27",
      "showCloseIcon": true,
      "closeIconImage": "sample string 29",
      "closeIconColor": "sample string 30",
      "closeIconThickness": 1,
      "closeIconCss": "sample string 31",
      "showBackground": true,
      "backgroundColor": "sample string 33",
      "backgroundOpacity": 1
    },
    "mobileBanner": {
      "bannerCss": "sample string 1",
      "title": "sample string 2",
      "titleCss": "sample string 3",
      "message": "sample string 4",
      "messageCss": "sample string 5",
      "showCloseIcon": true,
      "closeIconCss": "sample string 7",
      "showInfoIcon": true,
      "infoIconCss": "sample string 9",
      "showAcceptButton": true,
      "acceptButtonText": "sample string 11",
      "acceptButtonCss": "sample string 12",
      "showCollapsed": true,
      "collapsedMessage": "sample string 14",
      "collapsedMessageCss": "sample string 15",
      "showTitleWhenCollapsed": true
    }
  },
  "explicitConsent": {
    "banner": {
      "expandCookieOnLoad": true,
      "allowBackgroundClick": true,
      "reloadPage": true,
      "includeCookieNotice": true,
      "cookieNoticeUrl": "sample string 5",
      "cookieOnSubDomain": true,
      "customText": true,
      "bannerCss": "sample string 8",
      "title": "sample string 9",
      "titleCss": "sample string 10",
      "logo": "sample string 11",
      "logoSource": "QEA=",
      "logoImageType": "sample string 12",
      "logoCss": "sample string 13",
      "message": "sample string 14",
      "messageCss": "sample string 15",
      "cookieMessage": "sample string 16",
      "cookieMessageCss": "sample string 17",
      "cookieButtonText": "sample string 18",
      "cookieButtonIcon": "sample string 19",
      "cookieButtonIconSource": "QEA=",
      "cookieButtonIconImageType": "sample string 20",
      "cookieButtonCss": "sample string 21",
      "acceptMessage": "sample string 22",
      "acceptMessageCss": "sample string 23",
      "acceptButtonText": "sample string 24",
      "acceptButtonCss": "sample string 25",
      "backgroundColor": "sample string 26",
      "backgroundOpacity": 27
    },
    "mobile": {
      "expandCookieOnLoad": true,
      "allowBackgroundClick": true,
      "reloadPage": true,
      "includeCookieNotice": true,
      "cookieNoticeUrl": "sample string 5",
      "cookieOnSubDomain": true,
      "customText": true,
      "bannerCss": "sample string 8",
      "title": "sample string 9",
      "titleCss": "sample string 10",
      "logo": "sample string 11",
      "logoSource": "QEA=",
      "logoImageType": "sample string 12",
      "logoCss": "sample string 13",
      "message": "sample string 14",
      "messageCss": "sample string 15",
      "cookieMessage": "sample string 16",
      "cookieMessageCss": "sample string 17",
      "cookieButtonText": "sample string 18",
      "cookieButtonIcon": "sample string 19",
      "cookieButtonIconSource": "QEA=",
      "cookieButtonIconImageType": "sample string 20",
      "cookieButtonCss": "sample string 21",
      "acceptMessage": "sample string 22",
      "acceptMessageCss": "sample string 23",
      "acceptButtonText": "sample string 24",
      "acceptButtonCss": "sample string 25",
      "backgroundColor": "sample string 26",
      "backgroundOpacity": 27
    }
  },
  "tag": "sample string 16"
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'Ghostery.Privacy.Common.Objects.Site.SiteNotice'.

Response Information

Resource Description

System.Net.Http.HttpResponseMessage

Name	Type	Additional information
Version	System.Version	None.
Content	System.Net.Http.HttpContent	None.
StatusCode	System.Net.HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	System.Net.Http.HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.