POST api/v1/adnotice

Saves the Ad Notice.

Request Information

URI Parameters

None.

Body Parameters

Ghostery.Privacy.Common.Objects.Ad.AdNotice

Name	Type	Additional information
Id	integer	None.
Name	string	None.
CompanyId	integer	None.
AccountId	integer	None.
DivisionId	integer	None.
StatusId	integer	None.
Account	Ghostery.Privacy.Common.Objects.Ad.Account	None.
Division	Ghostery.Privacy.Common.Objects.Admin2.Division	None.
Icon	Ghostery.Privacy.Common.Objects.Ad.Icon	None.
Notices	Collection of Ghostery.Privacy.Common.Objects.Ad.Notice	None.
BillingCode	string	None.
Archived	boolean	None.
ShowIBALink	boolean	None.
ShowCustomLink	boolean	None.
AdServer	Ghostery.Privacy.Common.Objects.Ad.Vendor	None.
ThirdPartyDataVendors	Collection of Ghostery.Privacy.Common.Objects.Ad.Vendor	None.
AnalyticsVendors	Collection of Ghostery.Privacy.Common.Objects.Ad.Vendor	None.
Created	date	None.
CreatedByUserId	integer	None.
CreatedByUserName	string	None.
Modified	date	None.
Countries	string	None.
OwnerCompanyLogoUrl	string	None.

Request Formats

application/json, text/json

Sample:

{
  "id": 1,
  "name": "sample string 2",
  "companyId": 3,
  "accountId": 4,
  "divisionId": 5,
  "statusId": 6,
  "account": {
    "id": 1,
    "name": "sample string 2",
    "sfoId": "sample string 3",
    "customOptOutUrl": "sample string 4"
  },
  "division": {
    "id": 1,
    "companyId": 2,
    "name": "sample string 3",
    "description": "sample string 4",
    "deleted": true,
    "accountId": 6,
    "isDefault": true,
    "userRoles": {
      "1": [
        1,
        2
      ],
      "2": [
        1,
        2
      ]
    }
  },
  "icon": {
    "generic": true,
    "type": "sample string 2",
    "style": "sample string 3",
    "delay": 4,
    "grayscale": 5,
    "opacity": 6,
    "position": "sample string 7",
    "offsetX": 8,
    "offsetY": 9,
    "hasDAALicense": true
  },
  "notices": [
    {
      "id": 1,
      "default": true,
      "adNoticeId": 3,
      "countryId": 4,
      "countryName": "sample string 5",
      "countryCode": "sample string 6",
      "countryDomain": "sample string 7",
      "languageId": 8,
      "language": "sample string 9",
      "advertisers": [
        {
          "id": 1,
          "name": "sample string 2",
          "accountId": 3
        },
        {
          "id": 1,
          "name": "sample string 2",
          "accountId": 3
        }
      ],
      "overlay": {
        "showOverlay": true,
        "templateType": "sample string 2",
        "message": "sample string 3",
        "noticeText": "sample string 4",
        "url": "sample string 5",
        "logoUrl": "sample string 6",
        "image": "QEA=",
        "imageType": "sample string 7"
      },
      "mobileOverlay": {
        "displayOverlay": true,
        "message": "sample string 2"
      },
      "optOut": {
        "customizeOptOutPage": true,
        "heading": "sample string 2",
        "message": "sample string 3",
        "linkHeading": "sample string 4",
        "logoUrl": "sample string 5",
        "showWhatHappensLink": true,
        "showSelfRegulatoryLink": true,
        "showIBALink": true,
        "showGhosteryLink": true,
        "customLinks": [
          {
            "id": 1,
            "name": "sample string 2",
            "url": "sample string 3",
            "order": 4
          },
          {
            "id": 1,
            "name": "sample string 2",
            "url": "sample string 3",
            "order": 4
          }
        ],
        "privacyPolicyUrl": "sample string 10",
        "image": "QEA=",
        "imageType": "sample string 11",
        "useCustomClickThroughDesktop": true,
        "useCustomClickThroughMobileWeb": true,
        "useCustomClickThroughMobileApp": true,
        "desktopClickThroughUrl": "sample string 15",
        "mobileWebClickThroughUrlAndroid": "sample string 16",
        "mobileWebClickThroughUrlIos": "sample string 17",
        "mobileAppClickThroughUrlAndroid": "sample string 18",
        "mobileAppClickThroughUrlIos": "sample string 19",
        "logoType": 20
      },
      "advertiserName": "sample string 10"
    },
    {
      "id": 1,
      "default": true,
      "adNoticeId": 3,
      "countryId": 4,
      "countryName": "sample string 5",
      "countryCode": "sample string 6",
      "countryDomain": "sample string 7",
      "languageId": 8,
      "language": "sample string 9",
      "advertisers": [
        {
          "id": 1,
          "name": "sample string 2",
          "accountId": 3
        },
        {
          "id": 1,
          "name": "sample string 2",
          "accountId": 3
        }
      ],
      "overlay": {
        "showOverlay": true,
        "templateType": "sample string 2",
        "message": "sample string 3",
        "noticeText": "sample string 4",
        "url": "sample string 5",
        "logoUrl": "sample string 6",
        "image": "QEA=",
        "imageType": "sample string 7"
      },
      "mobileOverlay": {
        "displayOverlay": true,
        "message": "sample string 2"
      },
      "optOut": {
        "customizeOptOutPage": true,
        "heading": "sample string 2",
        "message": "sample string 3",
        "linkHeading": "sample string 4",
        "logoUrl": "sample string 5",
        "showWhatHappensLink": true,
        "showSelfRegulatoryLink": true,
        "showIBALink": true,
        "showGhosteryLink": true,
        "customLinks": [
          {
            "id": 1,
            "name": "sample string 2",
            "url": "sample string 3",
            "order": 4
          },
          {
            "id": 1,
            "name": "sample string 2",
            "url": "sample string 3",
            "order": 4
          }
        ],
        "privacyPolicyUrl": "sample string 10",
        "image": "QEA=",
        "imageType": "sample string 11",
        "useCustomClickThroughDesktop": true,
        "useCustomClickThroughMobileWeb": true,
        "useCustomClickThroughMobileApp": true,
        "desktopClickThroughUrl": "sample string 15",
        "mobileWebClickThroughUrlAndroid": "sample string 16",
        "mobileWebClickThroughUrlIos": "sample string 17",
        "mobileAppClickThroughUrlAndroid": "sample string 18",
        "mobileAppClickThroughUrlIos": "sample string 19",
        "logoType": 20
      },
      "advertiserName": "sample string 10"
    }
  ],
  "billingCode": "sample string 7",
  "archived": true,
  "showIBALink": true,
  "showCustomLink": true,
  "adServer": {
    "id": 1,
    "name": "sample string 2",
    "macros": [
      {
        "id": 1,
        "name": "sample string 2",
        "marker": "sample string 3",
        "replacementText": "sample string 4"
      },
      {
        "id": 1,
        "name": "sample string 2",
        "marker": "sample string 3",
        "replacementText": "sample string 4"
      }
    ]
  },
  "thirdPartyDataVendors": [
    {
      "id": 1,
      "name": "sample string 2",
      "macros": [
        {
          "id": 1,
          "name": "sample string 2",
          "marker": "sample string 3",
          "replacementText": "sample string 4"
        },
        {
          "id": 1,
          "name": "sample string 2",
          "marker": "sample string 3",
          "replacementText": "sample string 4"
        }
      ]
    },
    {
      "id": 1,
      "name": "sample string 2",
      "macros": [
        {
          "id": 1,
          "name": "sample string 2",
          "marker": "sample string 3",
          "replacementText": "sample string 4"
        },
        {
          "id": 1,
          "name": "sample string 2",
          "marker": "sample string 3",
          "replacementText": "sample string 4"
        }
      ]
    }
  ],
  "analyticsVendors": [
    {
      "id": 1,
      "name": "sample string 2",
      "macros": [
        {
          "id": 1,
          "name": "sample string 2",
          "marker": "sample string 3",
          "replacementText": "sample string 4"
        },
        {
          "id": 1,
          "name": "sample string 2",
          "marker": "sample string 3",
          "replacementText": "sample string 4"
        }
      ]
    },
    {
      "id": 1,
      "name": "sample string 2",
      "macros": [
        {
          "id": 1,
          "name": "sample string 2",
          "marker": "sample string 3",
          "replacementText": "sample string 4"
        },
        {
          "id": 1,
          "name": "sample string 2",
          "marker": "sample string 3",
          "replacementText": "sample string 4"
        }
      ]
    }
  ],
  "created": "2024-11-20T17:25:57.4535624+00:00",
  "createdByUserId": 12,
  "createdByUserName": "sample string 13",
  "modified": "2024-11-20T17:25:57.4535624+00:00",
  "countries": "sample string 15",
  "ownerCompanyLogoUrl": "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.Ad.AdNotice'.

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.