Developers
Banners

List banners

GET/banners

Lists the content banners of the current account.

The collection can be filtered by status, showcase_id, and deleted. Trashed banners are excluded by default; set deleted=true to list only trashed banners.

Results are paginated with limit and cursor and sorted by display position in ascending order. Use sort=-position to reverse the order.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Query Parameters

limit?integer
Range1 <= value <= 200
cursor?string
sort?string

Value in

  • "position"
  • "-position"
status?string

Value in

  • "active"
  • "inactive"
showcase_id?string
deleted?boolean

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/banners"
{  "data": [    {      "created_at": "2019-08-24T14:15:22Z",      "deleted": true,      "html": "string",      "id": "string",      "images": {        "desktop": "string",        "mobile": "string"      },      "link": {        "kind": "none",        "product_id": "string",        "target": "_self",        "url": "string"      },      "name": "string",      "object": "banner",      "position": 0,      "revision": "string",      "showcases": [        "string"      ],      "status": "active",      "type": "netflix",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Banners

Banners in API v3: list banners, create a banner, reorder banners, retrieve a banner, update a banner, delete a banner, duplicate a banner.

Create a banner POST

Creates a content banner. The banner `type` must be available for the account's current layout; otherwise, the API returns the `banner_type_unavailable` error code. Link URLs must use the HTTP or HTTPS scheme, and HTML content is sanitized before it is stored.