Manage Social Media Meta

Overview

This API allows you to update the meta title and description for live streams linked to Facebook and YouTube platforms via the Castr platform. Use this API to ensure your audience receives the most up-to-date information about your live streams.

Prerequisites

• The API is available for live streams linked to Facebook and YouTube platforms only.
• Ensure your platform is linked through the Castr dashboard using the Facebook and YouTube API. If the platform is not linked, updating meta information will not be possible.

HTTP Request

PATCH https://api.castr.com/v2/live_streams/{stream_id}/platforms/{platform_id}

URL Parameters

• stream_id - The unique identifier for the live stream you want to update.
• platform_id - The unique identifier for the platform (Facebook or YouTube) where the live stream is linked.

Headers

• Content-Type: application/json;charset=UTF-8 - Indicates the media type of the resource.
• Authorization: Basic {your_authentication} - Authentication credentials for HTTP authentication.

Request Body

Provide a JSON object with the following fields:

• name (string) - The name of the live stream. This is not the meta title but the internal name used in Castr.
• enabled (boolean) - Indicates whether the update should be applied (false means no updates will be applied).
• metadata (object) - Contains the meta information to be updated.
  • title (string) - The new meta title for the live stream.
  • description (string) - The new meta description for the live stream.

Example Request

curl --location --request PATCH 'https://api.castr.com/v2/live_streams/65d456f31a509bb08256dbaf/platforms/65d56ced091eb9d1e5dcc85b' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'Authorization: Basic {your_authentication}' \
--data '{
    "name": "Ted X - Live",
    "enabled": false,
    "metadata": {
        "title": "Add Your Title",
        "description": "Add Your Description"
    }
}'

 

Note: The API is available for streams linked to Facebook and YouTube platforms only.