---
title: "Add a background to an On Demand page"
method: POST
path: "/ondemand/pages/{ondemand_id}/backgrounds"
tags: ["On Demand\\Backgrounds"]
---

# Add a background to an On Demand page

`POST /ondemand/pages/{ondemand_id}/backgrounds`

## Request

- Base URL: `https://api.vimeo.com`
- URL: `https://api.vimeo.com/ondemand/pages/{ondemand_id}/backgrounds`
- Auth: OAuth 2
  - Authorization code: `/oauth/authorize`, token URL `/oauth/access_token`
  - Client credentials, token URL `/oauth/authorize/client`
  - Scopes: `upload`
- TypeScript: <https://skmtc.dev/vimeo/apis/vimeo-api/docs/ondemand/pages/:ondemand_id/backgrounds/post.ts> (a function with typed inputs; its response is checked against the schema)

Information about this method appears below.

## Path parameters

- `ondemand_id` number, required

## Response `200`

The background was created.

- Picture
  - `active` boolean, required: Whether this picture is the active picture for its parent resource.
  - `link` string: The upload URL for the picture. This field appears when you create the picture resource for the first time.
  - `resource_key` string, required: The picture's resource key string.
  - `sizes` object[], required: An array containing reference information about all available image files.
    - `height` number, nullable, required: The height of the image.
    - `link` string, required: The direct link to the image.
    - `link_with_play_button` string: The direct link to the image with a play button overlay.
    - `width` number, required: The width of the image.
  - `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.
  - `uri` string, required: The picture's URI.

## Other responses

- `403`: You can't modify an On Demand page that you don't own.
- `404`: No such On Demand page exists.

---

[API](https://skmtc.dev/vimeo/apis/vimeo-api.md) - [All operations](https://skmtc.dev/vimeo/apis/vimeo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vimeo/apis/vimeo-api/revisions/ea882e0224a4?raw)