Deletes a publishing scheduleRefers to a configuration that identifies a live channel or live event and a publishing target. Use a publishing schedule to syndicate a live channel or a live event to a social media platform..
Request
Request syntax:
DELETE /syndication-target/Publishing Schedule ID
Define the following variable when submitting the above request:
VariableA variable represents a value that must be replaced. A variable consists of either a URL segment (e.g., "0001" in /0001/) or a query string value (e.g., "3" in mediaTypes=3). | Description |
---|---|
Publishing Schedule ID Required | Replace this variable with the system-defined ID assigned to the desired publishing schedule. Use the Get Multiple Publishing Schedules endpoint to retrieve a list of publishing schedules and their 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 an endpoint that previously returned this publishing schedule. |
@type | String | Returns SyndicationSchedule. |
id | String | Returns Deleted upon successfully deleting the publishing schedule. |
Sample Request/Response
Call the delete_publishing_schedule module (Python 3) to delete a publishing schedule. This module imports names from the api_auth module.
import requests
from api_auth import APICredentials, APIParams
class PublishingSchedule:
def __init__(self):
self.host = "https://services.uplynk.com"
def run(self):
self._delete_publishing_schedule()
def _delete_publishing_schedule(self):
publishing_schedule_id = '587be125932f4428b83e4435e41503b7'
url = "{}{}{}".format(self.host, "/api/v4/syndication-schedule/", publishing_schedule_id)
headers = {'Content-Type': 'application/json'}
response = requests.delete(
url, params=APIParams(APICredentials()).get_params({}), headers=headers
)
print(response.json())
PublishingSchedule().run()
Response:
{
"@id": "/api/v4/syndication-schedule/4ebd413a120a428eba0adcd98df94927",
"@type": "SyndicationSchedule",
"message": "Deleted"
}