Create a new banner

Creates a new advertising banner.

Requires authentication.

Request

POST /banner

Headers

HeaderValue
AuthorizationBearer <token>
Content-Typeapplication/json

Request Body

FieldTypeRequiredDescription
namestringYesInternal display name for the banner.
activebooleanYesWhether the banner is active.
listTypestringYesThe page type: search, category, or manufacturer.
languagestringYesLanguage code this banner applies to (e.g. de, en).
titlestringNoBanner display title.
descriptionstringNoBanner description text.
linkstringNoTarget URL when the banner is clicked.
imagesarrayNoArray of image objects for the banner.
positionstringNoPosition of the banner on the page.
searchAutosuggestBothstringNoWhen listType is search, specify whether the banner shows on search, autosuggest, or both.
activeTimingbooleanNoWhen true, the activeFrom and activeTo scheduling fields are used.
activeFromstringNoISO 8601 start date/time for scheduled activation.
activeTostringNoISO 8601 end date/time for scheduled deactivation.
typeintegerNoBanner type identifier.
identifierarrayNoArray of search terms or category/manufacturer IDs this banner is triggered by.

Example Request

{
  "name": "Summer Sale Banner",
  "active": true,
  "listType": "search",
  "language": "de",
  "title": "Summer Sale",
  "link": "/summer-sale",
  "searchAutosuggestBoth": "both",
  "identifier": ["summer", "sale"]
}

Response

Returns the created banner object.

Body Params
boolean
string
string
enum
Allowed:
boolean
string
enum
Allowed:
string
string
string
string
images
array
images
string
string
string
integer
identifier
array
identifier
Response
200

Created

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!