Skip to navigation
CLOUD PLAYOUT APIChannel overlays

Remove an overlay from a channel

This endpoint takes an overlay off a Cloud Playout channel. The overlay itself stays in your workspace and can be placed again later.

How it works

  1. Make a DELETE request to this endpoint with the ID of the placement, which you can get from the get all overlays on a channel endpoint.

  2. The response confirms the removal.

If the channel is on air, the overlay stops being rendered from the next moment it would have appeared.

Example

A broadcaster removes a sponsor bug from the channel once the sponsorship period ends, keeping the overlay in the workspace for the next campaign.

Authentication

AuthorizationBasic

FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request.

  • Username: Access Token ID
  • Password: Secret Key

Activate your FastPix account to generate your API credentials. See the guide here

Path parameters

channelIdstringRequiredformat: "uuid"
The unique identifier of the channel the overlay is placed on.
overlayConfigIdstringRequiredformat: "uuid"

The unique identifier of the placement to remove, as returned in the id field by the get all overlays on a channel endpoint.

Response

Overlay removed from the channel successfully
successbooleanOptional
Shows the request status. Returns true for success and false for failure.