On Demand\Videos
Add a video to an On Demand page
Information about this method appears below.
put/ondemand/pages/{ondemand_id}/videos/{video_id}
Request
- Base URLhttps://api.vimeo.com
- AuthOAuth 2Authorization code/oauth/authorize, token URL /oauth/access_tokenClient credentialsToken URL /oauth/authorize/clientScopesedit
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
ondemand_idnumber required
Example:61326
The ID of the On Demand.
video_idnumber required
Example:12345
The ID of the video.
Request body
Example request
{
"buy": {
"price": {
"AUD": 1.99,
"CAD": 1.99,
"CHF": 1.99,
"DKK": 1.99,
"EUR": 1.99,
"GBP": 1.99,
"JPY": 1.99,
"KRW": 1.99,
"NOK": 1.99,
"PLN": 1.99,
"SEK": 1.99,
"USD": 1.99
}
},
"position": 10,
"release_year": 2018,
"rent": {
"price": {
"AUD": 0.99,
"CAD": 0.99,
"CHF": 0.99,
"DKK": 0.99,
"EUR": 0.99,
"GBP": 0.99,
"JPY": 0.99,
"KRW": 0.99,
"NOK": 0.99,
"PLN": 0.99,
"SEK": 0.99,
"USD": 0.99
}
}
}Response
The video was added.
Example response
{
"buy": {
"active": true,
"purchased": true
},
"description": "DARBY FOREVER follows the fantasies of Darby, a shopgirl at \"Bobbins & Notions\".",
"duration": "1197",
"episode": 1,
"interactions": {
"page": {
"added": true,
"uri": "/ondemand/pages/61326"
}
},
"link": "https://vimeo.com/ondemand/darbyforever/12345",
"metadata": {
"connections": {
"season": {
"name": "Season 1",
"uri": "/ondemand/pages/61326/seasons/12345"
}
},
"interactions": {
"likes": {
"added": true,
"added_time": "2017-05-12T21:42:42+00:00",
"uri": "/users/152184/likes/12345"
},
"watchlater": {
"added": true,
"added_time": "2017-05-12T21:42:42+00:00",
"uri": "/users/152184/watchlater/12345"
}
}
},
"name": "Darby Forever",
"pictures": {
"active": true,
"resource_key": "dc724af18fbdd4e59189f5fe768a5f8311527050",
"sizes": [
{
"height": 720,
"link": "https://i.vimeocdn.com/video/581495283_1280x720.jpg?r=pad",
"link_with_play_button": "https://i.vimeocdn.com/filter/overlay?src0=https%3A%2F%2Fi.vimeocdn.com%2Fvideo%2F581495283_1280x720.jpg&src1=http%3A%2F%2Ff.vimeocdn.com%2Fp%2Fimages%2Fcrawler_play.png",
"width": 1280
}
],
"type": "caution",
"uri": "/users/152184/pictures/12345"
},
"play_progress": 30,
"position": 1,
"release_date": "2017-05-12T21:06:42+00:00",
"release_year": 2016,
"rent": {
"active": true,
"purchased": true
},
"type": "main",
"uri": "/ondemand/pages/61326/videos/12345",
"user": {
"account": "basic",
"bio": "This is where you will find videos and news updates from the staff.",
"created_time": "2007-01-18T16:40:11+00:00",
"email": "user@example.com",
"link": "https://vimeo.com/staff",
"location": "New York City",
"metadata": {
"connections": {
"albums": {
"total": 3,
"uri": "/users/152184/albums"
},
"appearances": {
"total": 6,
"uri": "/users/152184/appearances"
},
"block": {
"total": 73,
"uri": "/me/block"
},
"categories": {
"total": 5,
"uri": "/users/152184/categories"
},
"channels": {
"total": 4,
"uri": "/users/152184/channels"
},
"feed": {
"uri": "/users/152184/feed"
},
"folders": {
"total": 9,
"uri": "/me/folders"
},
"followers": {
"total": 12,
"uri": "/users/152184/followers"
},
"following": {
"total": 47,
"uri": "/users/152184/following"
},
"groups": {
"total": 2,
"uri": "/users/152184/groups"
},
"likes": {
"total": 300,
"uri": "/users/152184/likes"
},
"moderated_channels": {
"total": 1,
"uri": "/users/152184/channels?filter=moderated"
},
"pictures": {
"total": 3,
"uri": "/users/152184/pictures"
},
"portfolios": {
"total": 5,
"uri": "/users/152184/portfolios"
},
"recommended_channels": {
"total": 4,
"uri": "/me/recommendations/channels"
},
"recommended_users": {
"total": 6,
"uri": "/me/recommendations/users"
},
"shared": {
"total": 15,
"uri": "/users/152184/shared/videos"
},
"videos": {
"total": 36,
"uri": "/users/152184/videos"
},
"watched_videos": {
"total": 322,
"uri": "/me/watched/videos"
},
"watchlater": {
"total": 14,
"uri": "/users/152184/watchlater"
}
},
"interactions": {
"add_privacy_user": {
"uri": "/channels/152184/privacy/users"
},
"block": {
"added": true,
"added_time": "2017-05-16T15:05:43+00:00",
"uri": "/me/block/3766357"
},
"follow": {
"added": true,
"uri": "/users/152184/following/3766357"
},
"report": {
"uri": "/users/152184/report"
}
}
},
"name": "Vimeo Staff",
"pictures": {
"active": true,
"resource_key": "dc724af18fbdd4e59189f5fe768a5f8311527050",
"sizes": [
{
"height": 720,
"link": "https://i.vimeocdn.com/video/581495283_1280x720.jpg?r=pad",
"link_with_play_button": "https://i.vimeocdn.com/filter/overlay?src0=https%3A%2F%2Fi.vimeocdn.com%2Fvideo%2F581495283_1280x720.jpg&src1=http%3A%2F%2Ff.vimeocdn.com%2Fp%2Fimages%2Fcrawler_play.png",
"width": 1280
}
],
"type": "caution",
"uri": "/users/152184/pictures/12345"
},
"preferences": {
"videos": {
"privacy": {
"add": true,
"comments": "anybody",
"download": true,
"embed": "private",
"view": "anybody"
}
}
},
"resource_key": "bac1033deba2310ebba2caec33c23e4beea67aba",
"upload_quota": {
"lifetime": {
"free": 5000000,
"max": 5368709120,
"used": 5368704120
},
"periodic": {
"free": 5000000,
"max": 5368709120,
"reset_date": "2029-03-13T02:35:13-04:00",
"used": 5368704120
},
"space": {
"free": 5000000,
"max": 5368709120,
"showing": "lifetime",
"used": 5368704120
}
},
"uri": "/users/152184",
"websites": [
{
"description": "Follow us on Twitter!",
"link": "https://twitter.com/vimeo",
"name": "Twitter"
}
]
}
}Changes
No recorded changes to this operation across all 13 revisions of this API.