Sign in

v1

latestOpenAPI 3.0.22026-07-1332837755.1 KB
Albums\Album videos

Set a video as the album thumbnail

Information about this method appears below.

post/me/albums/{album_id}/videos/{video_id}/set_album_thumbnail

Path parameters

album_idnumber required
Example:12345

The ID of the album.

video_idnumber required
Example:196367152

The ID of the video.

Request body

time_codenumber

The video frame time in seconds to use as the album thumbnail.

Example request

{
  "time_code": 300
}

Response

The album was updated with a new thumbnail.

allow_continuous_playboolean required

Whether an album should allow continuous play.

allow_downloadsboolean required

Whether an album should allow downloads.

allow_shareboolean required

Whether an album should allow sharing.

autoplayboolean required

Whether to start playback of the next video in the album's embedded playlist immediately after the previous video finishes.

brand_colorstring nullable required

Hexadecimal color code for the decorative color. For example, album videos use this color for player buttons.

created_timestring required

The time in ISO 8601 format that the album was created.

descriptionstring nullable required

A brief description of the album's content.

domainstring nullable required

The custom domain a user has selected for their album.

durationnumber required

The total duration in seconds of all the videos in the album.

embed_brand_colorboolean nullable required

Whether to show the album's custom brand color in the player of the album's embedded playlist.

embed_custom_logoboolean nullable required

Whether to show the album's custom logo in the player of the album's embedded playlist.

hide_navboolean required

Whether to hide the Vimeo navigation when viewing the album.

hide_vimeo_logoboolean nullable required

Whether to hide the Vimeo logo in the player of the album's embedded playlist.

layout'grid' | 'player' required

The album's layout preference

linkstring required

The URL to access the album.

loopboolean required

Whether automatic playback will restart at the top of the embedded playlist after reaching the end of the last video in the playlist.

modified_timestring required

The time in ISO 8601 format when the album was last modified.

namestring required

The album's display name.

resource_keystring required

The album resource key.

review_modeboolean required

Whether album videos should use the review mode URL.

share_linkstring required

The URL to share the showcase.

sort'added_first' | 'added_last' | 'alphabetical' | 'arranged' | 'comments' | 'likes' | 'newest' | 'oldest' | 'plays' required

Sort type of the album.

theme'dark' | 'standard' required

The album's color theme preference

uristring required

The album's URI.

urlstring nullable required

The custom Vimeo URL a user has selected for their album.

use_custom_domainboolean required

Whether the user has opted in to use a custom domain for their album.

web_brand_colorboolean required

Whether an album should show the brand color in the web layout.

web_custom_logoboolean required

Whether an album's custom logo should be shown in the web layout.

Example response

{
  "allow_continuous_play": true,
  "allow_downloads": true,
  "allow_share": true,
  "autoplay": true,
  "brand_color": "ff66ee",
  "created_time": "2015-12-17T21:32:44+00:00",
  "custom_logo": {
    "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"
  },
  "description": "Vimeo holiday videos!",
  "domain": "mycustomdomain.com",
  "duration": 1163,
  "embed_brand_color": true,
  "embed_custom_logo": true,
  "hide_nav": true,
  "hide_vimeo_logo": true,
  "layout": "grid",
  "link": "https://vimeo.com/album/Vimeo Holiday Videos!",
  "loop": true,
  "metadata": {
    "connections": {
      "videos": {
        "total": 6,
        "uri": "/albums/3706071/videos"
      }
    },
    "interactions": {
      "add_custom_thumbnails": {
        "uri": "/users/123456/albums/654321/custom_thumbnails"
      },
      "add_logos": {
        "uri": "/users/123456/albums/654321/logos"
      },
      "add_to": {
        "uri": "/albums/1234/videos/5678"
      },
      "add_videos": {
        "uri": "/users/123456/albums/654321/videos"
      }
    }
  },
  "modified_time": "2018-02-06T21:24:17+00:00",
  "name": "Vimeo Holiday Videos!",
  "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"
  },
  "privacy": {
    "password": "hunter1",
    "view": "anybody"
  },
  "resource_key": "e5595241643259c658ed6c85ca82985a6341edc7",
  "review_mode": true,
  "sort": "added_first",
  "theme": "dark",
  "uri": "/albums/3706071",
  "url": "my-custom-url",
  "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"
      }
    ]
  },
  "web_brand_color": true,
  "web_custom_logo": true
}