VIvimeo
On Demand\Backgrounds

Add a background to an On Demand page

Information about this method appears below.

post/ondemand/pages/{ondemand_id}/backgrounds

Request

Path parameters

ondemand_idnumber required
Example:61326

The ID of the On Demand.

Response

The background was created.

activeboolean required

Whether this picture is the active picture for its parent resource.

linkstring

The upload URL for the picture. This field appears when you create the picture resource for the first time.

resource_keystring required

The picture's resource key string.

type'caution' | 'custom' | 'default' required

The type of the picture:

Option descriptions:

  • caution - An image that is appropriate for all ages.
  • custom - A custom image for the video.
  • default - The default image for the video.
uristring required

The picture's URI.

Example response

{
  "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"
}

Changes

No recorded changes to this operation across all 13 revisions of this API.