POST api/v3/sitenotice
Saves the given site notice. If the passed in site notice has a non-zero identifier this call will act as an update. A missing or 0 id value will cause a new notice to be inserted. The passed in notice structure will be validated and if there are errors the return status code will be 500 and the return content will be a list of validation issues.
Request Information
URI Parameters
None.
Body Parameters
SiteNotice3Name | Description | Type | Additional information |
---|---|---|---|
Id | integer |
None. |
|
Templates | Collection of SiteNoticeTemplate |
None. |
|
Domain | string |
Required |
|
IncludeSubdomains | SiteNoticeIncludeDomainType |
None. |
|
DivisionId | integer |
Required |
|
SiteNoticeThemeId | integer |
Required |
|
ConsentToolThemeId | integer |
Required |
|
ConsentDisplayTypeId | integer |
Required |
|
Countries | Collection of SiteNoticeCountry |
Required |
|
Translations | Collection of SiteNoticeTranslation |
Required |
|
StagingNotice | boolean |
None. |
|
DivisionName | string |
None. |
|
ThemeName | string |
None. |
|
ConsentToolName | string |
None. |
|
CountryCount | integer |
None. |
|
TranslationCount | integer |
None. |
|
CountryNames | string |
None. |
|
TranslationNames | string |
None. |
|
CreatedBy | string |
None. |
|
Created | date |
None. |
|
UpdatedBy | string |
None. |
|
Updated | date |
None. |
Request Formats
application/json
Sample:
text/json
Sample:
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
SiteNotice3Name | Description | Type | Additional information |
---|---|---|---|
Id | integer |
None. |
|
Templates | Collection of SiteNoticeTemplate |
None. |
|
Domain | string |
Required |
|
IncludeSubdomains | SiteNoticeIncludeDomainType |
None. |
|
DivisionId | integer |
Required |
|
SiteNoticeThemeId | integer |
Required |
|
ConsentToolThemeId | integer |
Required |
|
ConsentDisplayTypeId | integer |
Required |
|
Countries | Collection of SiteNoticeCountry |
Required |
|
Translations | Collection of SiteNoticeTranslation |
Required |
|
StagingNotice | boolean |
None. |
|
DivisionName | string |
None. |
|
ThemeName | string |
None. |
|
ConsentToolName | string |
None. |
|
CountryCount | integer |
None. |
|
TranslationCount | integer |
None. |
|
CountryNames | string |
None. |
|
TranslationNames | string |
None. |
|
CreatedBy | string |
None. |
|
Created | date |
None. |
|
UpdatedBy | string |
None. |
|
Updated | date |
None. |
Response Formats
application/json
Sample:
text/json
Sample: