POST
/
cms
/
banner_collections
/
v1

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
id
string
required

A unique identifier for the banner collection. This can be set manually, or auto-generated if left empty.

project_id
string
required
name
string
required

A name for visual identification within the management UI. Does not appear towards end users.

banner_ids
string[]

A list of banner ids that should be included in this banner collection. The order of this list determines the order in which the banners are displayed towards end users.

visibility
enum<string>
Available options:
VISIBILITY_UNSPECIFIED,
VISIBILITY_PUBLISHED,
VISIBILITY_UNLISTED,
VISIBILITY_HIDDEN

Response

200 - application/json
banner_collection
object

BannerCollection represents a collection of banners that can be displayed in a carousel on an end-user facing web/app page.

List banner collectionsUpdate banner collection