Skip to main content
POST
/
cms
/
banner_collections
/
v2
cURL
curl --request POST \
  --url https://api.mottostreaming.com/cms/banner_collections/v2 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "project_id": "<string>",
  "name": "<string>",
  "banner_ids": [
    "<string>"
  ],
  "visibility": "VISIBILITY_UNSPECIFIED",
  "is_preview": true,
  "source_banner_collection_id": "<string>"
}
'
{
  "banner_collection": {
    "id": "<string>",
    "project_id": "<string>",
    "name": "<string>",
    "banner_ids": [
      "<string>"
    ],
    "visibility": "VISIBILITY_UNSPECIFIED",
    "is_preview": true,
    "source_banner_collection_id": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

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

​
id
string
required

A unique identifier for the banner collection. The system will generate this value.

​
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
​
is_preview
boolean

Indicates that this banner collection is a preview banner collection. Preview banner collections are not shown to end users, but can be used for testing and previewing changes. When you wish to deploy a preview banner collection to production (your main platform for end users), you should use CloneBannerCollection.

​
source_banner_collection_id
string

The banner collection ID of the production page that this preview banner collection is based on. This field is only relevant when "is_preview" is true. It will be set automatically when using the "CloneBannerCollection" API method.

Response

OK

​
banner_collection
object

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