POST api/v3/sitenotice/admin/consenttool

Saves the consent tool theme. This action behaves as an upsert action. If the id value is missing or 0 this will create a new consent tool theme. If the id value is present it will attempt to modify the existing theme.

Request Information

URI Parameters

None.

Body Parameters

Ghostery.Privacy.Common.Objects.Site3.ConsentTool
NameDescriptionTypeAdditional information
Id

integer

None.
Name

string

None.
Desktop

Ghostery.Privacy.Common.Objects.Site3.ConsentToolSetting

None.
DesktopAssets

Ghostery.Privacy.Common.Objects.Site3.ConsentToolAsset

None.
Mobile

Ghostery.Privacy.Common.Objects.Site3.ConsentToolSetting

None.
MobileAssets

Ghostery.Privacy.Common.Objects.Site3.ConsentToolAsset

None.
Notices

Collection of Ghostery.Privacy.Common.Objects.Site3.SiteNotice

None.
Styles

string

None.
BackgroundColor

string

None.
FontColor

string

None.
Logo

string

None.
NoticeCount

integer

None.

Request Formats

application/json

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'Ghostery.Privacy.Common.Objects.Site3.SiteNotice'. Path 'notices[0].templates[0].notices'.

text/json

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'Ghostery.Privacy.Common.Objects.Site3.SiteNotice'. Path 'notices[0].templates[0].notices'.

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.Site3.ConsentTool'.

Response Information

Resource Description

Ghostery.Privacy.Common.Objects.Site3.ConsentTool
NameDescriptionTypeAdditional information
Id

integer

None.
Name

string

None.
Desktop

Ghostery.Privacy.Common.Objects.Site3.ConsentToolSetting

None.
DesktopAssets

Ghostery.Privacy.Common.Objects.Site3.ConsentToolAsset

None.
Mobile

Ghostery.Privacy.Common.Objects.Site3.ConsentToolSetting

None.
MobileAssets

Ghostery.Privacy.Common.Objects.Site3.ConsentToolAsset

None.
Notices

Collection of Ghostery.Privacy.Common.Objects.Site3.SiteNotice

None.
Styles

string

None.
BackgroundColor

string

None.
FontColor

string

None.
Logo

string

None.
NoticeCount

integer

None.

Response Formats

application/json

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'Ghostery.Privacy.Common.Objects.Site3.SiteNotice'. Path 'notices[0].templates[0].notices'.

text/json

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'Ghostery.Privacy.Common.Objects.Site3.SiteNotice'. Path 'notices[0].templates[0].notices'.