Deletes a live channel.

Request

Request syntax:

DELETE /channels/{Live Channel ID}

Define the following variable when submitting the above request:

Variable	Description
Live Channel ID Required	Identifies a live channel by its system-defined ID.

Response

The response for a successful request contains the following properties:

Name	Data Type	Description
@id	String	Indicates the relative path to this endpoint.
@type	String	Returns Channel.
message	String	Returns Deleted when the specified live channel has been successfully deleted.

Sample Request/Response

The code below (Python 3) shows how to delete a live channel.

This code imports names from the api_auth module for V4 APIs (see below).

import json, requests
from api_auth import APICredentials, APIParams
channel_id = 'Hak3zjnPLSW5o0j8GMpzRMsa' # Replace with the ID for the desired live channel.

class DeleteLiveChannel:
    def __init__(self):
        self.host = "https://services.uplynk.com"

    def run(self):
        """
        Deletes a live channel.
        """
        self._delete_live_channel()

    def _delete_live_channel(self):
        url = "{}{}{}".format(self.host, "/api/v4/channels/", channel_id)

        response = requests.delete(
            url, params=APIParams(APICredentials()).get_params({})
        )

        print(response.json())

DeleteLiveChannel().run()

Response:

{
	"@id": "/channels/Hak3zjnPLSW5o0j8GMpzRMsa",
	"@type": "Channel",
	"message": "Deleted"
}