Update a banner
/banners/{banner_id}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.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Header Parameters
Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Optional on this operation; when sent, a malformed key returns idempotency_key_invalid, and repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.
Expected revision of the resource, in the same format as the ETag header (W/"<type>:<id>:<revision>"). If the resource has changed since that revision, the request fails with 412 and the revision_mismatch error code. When omitted, the update is applied to the current revision.
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.
length <= 64Request 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
curl -X PATCH "https://example.com/banners/string" \ -H "Content-Type: application/json" \ -d '{}'{ "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" }}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. Banners in the trash are not returned and respond with `404 Not Found`. To restore one, send `deleted: false` to the update operation.
Delete a banner DELETE
Moves the banner to the trash instead of permanently deleting it. Trashed banners can be restored through the update operation. Replicated banners are read-only and cannot be deleted. Attempts to delete them return `403` with the `replica_readonly` error code.