VIvimeo
Users\Pictures

Edit a user picture

This method edits a portrait image belonging to the authenticated user.

patch/users/{user_id}/pictures/{portraitset_id}

Request

Path parameters

portraitset_idnumber required
Example:12345

The ID of the picture.

user_idnumber required
Example:152184

The ID of the user.

Request body

activeboolean

Whether the picture is the authenticated user's active portrait.

Example request

{
  "active": true
}

Response

The portrait image was edited.

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.