POST Create Playlist

Syntax

The following method is used to create a new playlist object in the system using POST.

Note: This method creates a playlist object by passing a valid playlist JSON object in the POST body raw data.



URL
Note: The parameter highlighted in red is a placeholder for the mandatory value described bellow.

http://api.vidible.tv/COMPANY_KEY/playlist
  • COMPANY_KEY - Replace this placeholder with your Company Key.
    Note: If you do not have a Company Key, please contact our support team and provide your company's name and details.

JSON Payload

  • JSON Playlist Object - Pass a valid JSON Playlist Object via the method's 'Body' 'Raw' data. For further details on how to structure the Playlist JSON Object, please see Playlist JSON object specification.

    Important! 'Content-type' parameter header must be set with a value of 'application/json'.

Try it out by clicking here.

 

Examples

 

Static Playlist Create Request

DescriptionThis method is for creating a new playlist by specifying relevant Video IDs.

Method: POST

URL:

http://api.vidible.tv/5d3f3b3ac9374m3463be2557e04697ad/playlist 

JSON Object

Note: The following JSON Object is sent via the 'Body' 'Raw' data with a Header 'Content-type' parameter set to 'application/json'.

{
"name" : "Create Static Playlist",
"companyId" : "545db032e4b0af1a81424b48",
"staticVideos" : [
"56f17cc8e4b05b1a3f583e69",
"56eab78de4b00a7b045b0482"
]

Response

{
"id": "5745aeaee4b0a64e5767382a",
"creationDate": 1464184493846,
"name": "test playlist create",
"keywords": [],
"topics": [],
"price": 0,
"searchCriteria": {
"videoSearchCriteria": {
"includeOwned": true,
"includeNotOwned": true,
"includeHidden": false,
"includeNotHidden": true,
"includeReadOnly": true,
"includeNotReadOnly": true,
"limit": 0,
"offset": 0,
"rawQuery": "",
"userCreated": true,
"systemCreated": false,
"searcherSids": [],
"filterStrings": [],
"ignoreContentVisibilityRules": false,
"searchScope": "COMMON",
"prepared": false,
"filterFields": {
"playbackavailable": {
"name": "playbackavailable",
"values": [
"true"
],
"include": true
}
},
"orFields": [],
"orFilters": [],
"companyRatingMode": "EQ",
"includeMinPrice": true,
"includeMaxPrice": true,
"entitySearchValues": [],
"suggestUrl": "",
"searchCausedFromVideoListView": false,
"videoListViewSids": [],
"includeMale": true,
"includeFemale": true,
"languages": [],
"ageRatings": [],
"contentRatings": [],
"contentDescriptors": [],
"includeNoDescriptorsSet": false,
"categories": [],
"iabCategories": [],
"sentToReencodeOptions": [],
"videoApprovalStates": [],
"moderationStatuses": [],
"availabilities": [
"a"
],
"priceHandlingStrategy": {
"type": "no"
},
"taxonomyCategories": [],
"supportedPlayerTypes": [],
"availabilitiesPermitted": true,
"domains": [],
"companyGroupIds": []
}
},
"staticVideos": [
"56f17cc8e4b05b1a3f583e69",
"56eab78de4b00a7b045b0482"
],
"semantic": false,
"dynamic": false,
"staticFirst": true,
"geoTargeting": false,
"bidRestriction": {
"availabilityScope": "EVERYWHERE",
"accessibilityScope": "PRIVATE",
"blackListMode": true,
"companyWhiteList": [],
"companyBlackList": [],
"companyGroupBlackList": [],
"companyGroupWhiteList": []
},
"companyId": "56d5921ce4b0f5991ad44713",
"associatedCompanies": [],
"parentCompanyId": "545db032e4b0af1a81424b48",
"tags": [],
"customAttributes": {},
"workflowType": "DEFAULT",
"deleted": false,
"readOnly": false,
"hidden": false,
"origin": "MANUALLY"
}

 

Dynamic Playlist Create Request

DescriptionThis method is for creating a new playlist using a search query.

Method: POST

URL:

http://api.vidible.tv/5d3f3b3ac9374m3463be2557e04697ad/playlist 

JSON Object

Note: The following JSON Object is sent via the 'Body' 'Raw' data with a Header 'Content-type' parameter set to 'application/json'.

{
"name" : "Create Dynamic Playlist",
"companyId" : "545db032e4b0af1a81424b48",
"dynamic": true,
"searchCriteria": {
"rawQuery": "harley davidson"
}

Response

{
"id": "57714005cc52c72ddb8879d0",
"creationDate": 1467039749312,
"name": "Create API Dynamic Playlist",
"keywords": [],
"topics": [],
"price": 0,
"searchCriteriaFields": {
"includeOwned": true,
"includeNotOwned": true,
"includeHidden": false,
"includeNotHidden": true,
"includeReadOnly": true,
"includeNotReadOnly": true,
"userCreated": true,
"systemCreated": false,
"includeMale": true,
"includeFemale": true,
"rawQuery": "",
"companyGroupIds": [],
"languages": [],
"ageRatings": [],
"contentRatings": [],
"contentDescriptors": [],
"categories": []
},
"semantic": false,
"dynamic": true,
"staticFirst": true,
"geoTargeting": false,
"bidRestriction": {
"availabilityScope": "EVERYWHERE",
"accessibilityScope": "PRIVATE",
"blackListMode": true,
"companyWhiteList": [],
"companyBlackList": [],
"companyGroupBlackList": [],
"companyGroupWhiteList": []
},
"ownerId": "54c8917de4b0cbf701977c41",
"companyId": "56d5921ce4b0f5991ad44713",
"associatedCompanies": [],
"parentCompanyId": "545db032e4b0af1a81424b48",
"modifierId": "54c8917de4b0cbf701977c41",
"tags": [],
"customAttributes": {},
"workflowType": "DEFAULT",
"deleted": false,
"readOnly": false,
"hidden": false,
"origin": "SYSTEM"
}

 

 

Combined Playlist Create Request

DescriptionThis method is for creating a new playlist using both static videos and a dynamic search query.

Method: POST

URL:

http://api.vidible.tv/5d3f3b3ac9374m3463be2557e04697ad/playlist 

JSON Object

Note: The following JSON Object is sent via the 'Body' 'Raw' data with a Header 'Content-type' parameter set to 'application/json'.

{
"name" : "Create Combined Playlist",
"companyId" : "545db032e4b0af1a81424b48",
"staticVideos" : [
"56f17cc8e4b05b1a3f583e69",
"56eab78de4b00a7b045b0482"
],
"staticFirst": true,
"searchCriteria": {
"rawQuery": "motorcycles"
}
}

Response

{
"id": "5771418454dea34b2d5bd83a",
"creationDate": 1467040132542,
"name": "Create Combined Playlist",
"keywords": [],
"topics": [],
"price": 0,
"searchCriteriaFields": {
"includeOwned": true,
"includeNotOwned": true,
"includeHidden": false,
"includeNotHidden": true,
"includeReadOnly": true,
"includeNotReadOnly": true,
"userCreated": true,
"systemCreated": false,
"includeMale": true,
"includeFemale": true,
"rawQuery": "",
"companyGroupIds": [],
"languages": [],
"ageRatings": [],
"contentRatings": [],
"contentDescriptors": [],
"categories": []
},
"staticVideos": [
"56f17cc8e4b05b1a3f583e69",
"56eab78de4b00a7b045b0482"
],
"semantic": false,
"dynamic": true,
"staticFirst": true,
"geoTargeting": false,
"bidRestriction": {
"availabilityScope": "EVERYWHERE",
"accessibilityScope": "PRIVATE",
"blackListMode": true,
"companyWhiteList": [],
"companyBlackList": [],
"companyGroupBlackList": [],
"companyGroupWhiteList": []
},
"ownerId": "54c8917de4b0cbf701977c41",
"companyId": "56d5921ce4b0f5991ad44713",
"associatedCompanies": [],
"parentCompanyId": "545db032e4b0af1a81424b48",
"modifierId": "54c8917de4b0cbf701977c41",
"tags": [],
"customAttributes": {},
"workflowType": "DEFAULT",
"deleted": false,
"readOnly": false,
"hidden": false,
"origin": "SYSTEM"
}

 

Have more questions? Submit a request