Create a banner
/bannersCreates 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.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/banners" \ -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, ordered by position. 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. Returns all matching banners in a single response while preserving the standard collection response format.
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.