updateVodOffer()


This method lets you update a VOD offer via Cleeng API.

Parameters:

Name Type Description
publisherToken string You can find your publisher token at api-keys page.
offerIdString stringID of the offer
offerData object All data describing new offer.
-pricefloatOffer price (in publisher's currency), value between 0.14 and 99.99
-titlestringTitle of the offer, up to 70 chars.
-urlstringUrl to your content.
-description stringAdditional offer description, up to 110 chars
-associateEmail stringAvailable only for enterprise account
-videoId stringUnique identifier of your video asset
-playerCode stringPlayer's embed code
-playerCodeHead stringPlayer's head code
-rentalPeriod stringRental period
-runtime stringVideo duration time
-videoQuality stringVideo quality, e.g. 4k
-backgroundImageUrl string
-eventAssociation arrayArray of offer Id of live events which access should be transferred on this VOD
-tags arrayTags attached to offer. Read more.
-geoRestrictionEnabled boolSet "true" to enable geo-restriction on this offer
-geoRestrictionType stringChoose type of geo-restriction: whitelist / blacklist
-geoRestrictionCountries arrayBased on geoRestrictionType, set the array of whitelisted/blacklisted countries.

- required parameter

Response Parameters:

Name Type Description
id string ID of the offer
title string Offer name
description string Offer description
url string Link to the offer
price string Offers price
videoId string Unique identifier of your video asset
rentalPeriod string Rental period
publisherEmail string Contact email to the publisher
playerCode string Player's embed code
playerCodeHead string Player's head code
streamingPlatform string Streaming platform, e.g. YouTube
runtime string Video duration time
videoQuality string Video quality, e.g. 4k
backgroungImageUrl array Array of urls to backgroung image in different sizes
-small string
-medium string
-large string
eventAssociation array Array of associated events
geoRestrictionEnabled boolean 'true' if the offer is georesctricted
geoRestrictionType string Choose type of geo-restriction: whitelist / blacklist
geoRestrictionCountries array Based on geoRestrictionType, set the array of whitelisted/blacklisted countries
membershipOnly boolean If 'true', the offer can be only accessed by a subscription and cannot be purchased directly
createdAt integer Unix timestamp
updatedAt integer Unix timestamp
tags array Array of Offers tags

Request:

[
    {
        "method": "updateVodOffer",
        "params": {
            "publisherToken": "OchFjivBxu8EWQD123YVEkLJXz8UTex7EhkCbBYbjQwthIpl",
            "offerIdString": "A376856349_PL",
            "offerData": {
                "price": "13",
                "title": "Test Vod2",
                "url": "testvod.cleeng.com",
                "description": "test vod offer2",
                "playerCode": "<iframe>playercode<\/iframe>",
                "runtime": "3321",
                "videoQuality": "4k",
                "backgroundImageUrl": "cleeng.com\/pic1.jpg",
                "eventAssociation": [],
                "tags": [
                    "vod",
                    "olympics"
                ],
                "geoRestrictionCountries": []
            }
        },
        "jsonrpc": "2.0",
        "id": 1
    }
]

Response:

[
    {
        "result": {
            "vod": {
                "id": "A376812349_PL",
                "title": "Test Vod2",
                "description": "test vod offer2",
                "url": "testvod.cleeng.com",
                "price": "10.5691",
                "videoId": null,
                "rentalPeriod": 0,
                "publisherEmail": "broadcaster@domain.com",
                "playerCode": "playercode",
                "playerCodeHead": "",
                "streamingPlatform": null,
                "runtime": "3321",
                "videoQuality": "4k",
                "backgroundImageUrl": {
                    "small": "cleeng.com\/pic1.jpg",
                    "medium": "cleeng.com\/pic1.jpg",
                    "large": "cleeng.com\/pic1.jpg"
                },
                "eventAssociation": [],
                "geoRestrictionEnabled": false,
                "geoRestrictionType": null,
                "geoRestrictionCountries": [],
                "membershipOnly": false,
                "createdAt": 1514897470,
                "updatedAt": 1514898159,
                "tags": [
                    "vod",
                    "olympics"
                ]
            }
        },
        "id": "1",
        "jsonrpc": "2.0"
    }
]

Remember! you can always check it by yourself using API Console - updateVodOffer()

Back to VOD Offers


We use cookies to ensure that we provide you the best service and website experience. Read our Cookie policy for more details.