Developers
Banners7

Create a banner

POST/banners

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.

Authorization

AuthorizationBearer <token>

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

In: header

Header Parameters

Idempotency-Key*string

Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Required by this operation: a missing key returns idempotency_key_required, and a malformed key returns idempotency_key_invalid. Repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/banners" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "type": "netflix"  }'
{  "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"  }}

List banners GET

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.

Reorder banners PUT

Sets the display order of the account's content banners. The `ids` array must contain the public ID of every banner that is not in the trash, both active and inactive, in the desired order. If the supplied set does not match, the API returns the `order_set_mismatch` error code and the existing order remains unchanged.