Reorder banners
/banners/orderSets 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.
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 PUT "https://example.com/banners/order" \ -H "Content-Type: application/json" \ -d '{ "ids": [ "string" ] }'{ "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" }}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.
Retrieve a banner GET
Retrieves a content banner by its public ID. The response includes an `ETag` header representing the current revision. Send this value in the `If-Match` header when updating the banner to avoid overwriting a newer version.