VIvimeo
Albums\Custom album logos

Replace a custom album logo

Changed on

This method replaces the specified custom album logo with a new image file. For information on how to upload the logo, see our Working with Thumbnail Uploads guide, and follow the same steps.

patch/users/{user_id}/albums/{album_id}/logos/{logo_id}

Request

Path parameters

album_idnumber required
Example:3706071

The ID of the album.

logo_idnumber required
Example:12345

The ID of the custom logo.

user_idnumber required
Example:152184

The ID of the user.

Request body

activeboolean

Whether to make this the active album logo.

Example request

{
  "active": true
}

Response

The custom logo was replaced.

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

  • 89b756668a1eRevision changes
    • info

      api operation id edit_album_logo removed and replaced with replace_album_logo

    • info

      api tag Albums\Custom album logos added

    • info

      api tag Albums\Custom Logos removed

  • 26f856a94041Revision changes
    • info

      api operation id replace_album_logo removed and replaced with edit_album_logo

    • info

      api tag Albums\Custom Logos added

    • info

      api tag Albums\Custom album logos removed