Delete a banner
/banners/{banner_id}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.
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.
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 <= 64Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/banners/string"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.
Duplicate a banner POST
Creates a copy of an existing content banner, including its showcase assignments. The copy receives a new public ID and a name derived from the original.