v1

latestOpenAPI 3.0.02026-07-26221117272.0 KB

Banner

Add banner

Adds a banner to HawkSearch

post/api/v11/banner

Headers

X-HawkSearch-ApiKeystring required

Request body

Idinteger

SyncGuidstring uuid

Namestring required

BannerTypestring

Widthinteger

Heightinteger

Linkstring

Filenamestring

AltTextstring

HTMLstring

Targetstring

IsTrackingEnabledboolean

RuleXMLstring

RuleStylestring

RuleSortFieldIdinteger

RuleNofItemsinteger

RuleSortDirectionstring

RuleTitlestring

RuleIsDynamicboolean

WidgetIdinteger

WidgetArgsstring

Tagsstring

IsMobileboolean

DisableHtmlEditorboolean

MobileBannerTypestring

MobileIsTrackingEnabledboolean

MobileHTMLstring

MobileWidthinteger

MobileHeightinteger

MobileLinkstring

MobileAltTextstring

MobileTargetstring

MobileFileNamestring

MobileWidgetIdinteger

MobileWidgetArgsstring

MobileCustomWidgetArgsstring

MobileDisableHtmlEditorboolean

CustomWidgetArgsstring

CreateDatestring date-time

ModifyDatestring date-time

IsTabletboolean

TabletBannerTypestring

TabletIsTrackingEnabledboolean

TabletHTMLstring

TabletWidthinteger

TabletHeightinteger

TabletLinkstring

TabletAltTextstring

TabletTargetstring

TabletFileNamestring

TabletWidgetIdinteger

TabletWidgetArgsstring

TabletCustomWidgetArgsstring

TabletDisableHtmlEditorboolean

Example request

{
  "SyncGuid": "00000000-0000-0000-0000-000000000000"
}

Response