Deprecated
This endpoint is deprecated and no longer available.
This method lets you deactivate VOD offer via Cleeng API.
Warning
This API is no longer supported for offers with localized versions. If you would like to create or modify an offer with localizations, you can do so directly in the Cleeng dashboard.
Parameters
| Name | Type | Description |
|---|---|---|
| publisherToken* | string | You can find your publisher token at api-keys page. |
| offerIdString* | string | ID of the offer |
Result 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 |
API Request/Response
Request
{
"method": "deactivateVodOffer",
"params": {
"publisherToken": "OchFjivBxu8WQEdsad2YVEkLJXz8UTex7EhkCbBYbjQwthIpl",
"offerIdString": "A376843129_PL"
},
"jsonrpc": "2.0",
"id": 1
}
Response
{
"result": {
"vod": {
"id": "A376843129_PL",
"title": "Test Vod2",
"description": "test vod offer2",
"url": "testvod.cleeng.com",
"price": "10.5691",
"videoId": null,
"rentalPeriod": 0,
"publisherEmail": "[email protected]",
"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"
}