Start / Stop Publishing

Start or stop publishing to a social media or content distribution platform.

Request

Request syntax:

PATCH /syndication-schedule-action/Publishing Schedule ID

Define the following variable when submitting the above request:

Request body parameter:

Pass the following request body parameter:

Response

The response for a successful request contains the following properties:

target_platform_config Dictionary

The target_platform_config dictionary describes a social media or content distribution platform's settings via the following properties:

Sample Request/Response

Call the start_stop_publishing module (Python 3) to start or stop a publishing schedule. This module imports names from the api_auth module.

import json
import requests
from api_auth import APICredentials, APIParams

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

    def run(self):
        self._action_publishing_schedule()

    def _action_publishing_schedule(self):

        publishing_schedule_id = '04359728c4d346ac918ba7b3edff2cb1'
        url = "{}{}{}".format(self.host, "/api/v4/syndication-schedule-action/", publishing_schedule_id)

        payload = {
            'mode': 'stop'
        }

        headers = {'Content-Type': 'application/json'}

        response = requests.patch(
            url, params=APIParams(APICredentials()).get_params({}), data=json.dumps(payload), headers=headers
        )

        print(response.json())

StartStopPublishingSchedule().run()

Response:

{
	"@id": "/api/v4/syndication-schedule-action/04359728c4d346ac918ba7b3edff2cb1",
	"@type": "StartSyndicationSchedule",
	"id": "04359728c4d346ac918ba7b3edff2cb1",
	"start": 1588098944096,
	"stop": 1588098960071,
	"syndication_target_id": "d30f655670cb426c98cd28afb6291bf4",
	"status": "stopped",
	"last_status": 1588098960071,
	"err_msg": "",
	"type": "downloader",
	"video_quality": "high",
	"audio_track": "",
	"content_id": "1df8d13992cd4222a7343b8fafd89cd7",
	"content_type": "c",
	"syndication_target_description": "Sample"
}