Developers
Banners

Retrieve a banner

GET/banners/{banner_id}

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.

Banners in the trash are not returned and respond with 404 Not Found. To restore one, send deleted: false to the update operation.

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

banner_id*string

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

curl -X GET "https://example.com/banners/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"  }}

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.

Update a banner PATCH

Updates an existing content banner. Only the fields included in the request are changed. Updating `status` requires the `banners.publish` permission in addition to `banners.update`. Setting `deleted` to `false` restores a banner from the trash. Changing the banner `type` is subject to the same layout availability rule as creation. Send the `ETag` returned by the retrieve operation in the `If-Match` header to prevent overwriting changes made since the banner was retrieved. Replicated banners accept only `status` updates. Including any other field returns `403` with the `replica_readonly` error code.