CLcleverpush
WebBanner

Create_WebBanner

Create WebBanner

post/channel/{channelId}/web-banners

Request

  • Base URL
    https://api.cleverpush.com (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Path parameters

channelIdstring required

The Channel ID

Request body

namestring required
contentStateobject required
buttonStyleobject required
startsAtstring required
endsAtstring required
timeoutnumber required
statusstring required
matchPathstring required
matchDomainstring required
matchQueryobject required
noMatchPathstring required
matchFunctionstring required
trafficPercentagenumber required
scrollPercentagenumber required
showOnlySubscribersboolean required
customCssstring required
darkenBackgroundboolean required
exitIntentboolean required
exitIntentForMobileboolean required
enableRegularDisplayForMobileboolean required
minimumVisitsnumber required
attributesobject[] required
oncePerClickboolean required
frequencystring required
frequencyIntervalnumber required
tagsstring[] required
excludeTagsstring[] required
topicsstring[] required
excludeTopicsstring[] required
topicsLogicstring required
tagsLogicstring required

Response

Success-Response:

webBannerIdstring
statusboolean
Stringstring required
<p>containing webBannerId</p>
Booleanboolean required
<p>value containing status field</p>

Changes

No recorded changes to this operation across all 3 revisions of this API.