Bookmarks

Edit a bookmark

Edit a placeholder for the current media that you can return to later.

patch/videos/{video_id}/bookmark

Path parameters

video_idstring required

Unique identifier of the video.

Query parameters

positioninteger
clientstring

Client/agent name recorded with the request.

dateinteger
include0 | 1

Request body

positioninteger required
clientstring

Client/agent name recorded with the request.

dateinteger
include0 | 1

Response

Bookmark array

idstring required
ownerstring required
object_typestring nullable required

The kind of object referenced, as a bare string. The set is intentionally open so a new media type is not a breaking change; values seen today include song, album, artist, playlist, podcast, podcast_episode and video.

object_idstring required
positioninteger required
clientstring nullable required
creation_dateinteger required
update_dateinteger required

Changes

Changed in 10 of the 46 revisions of this API.127

    • added the required property song/items/mood to the response with the 200 status

      response-required-property-added

    • added the required property song/items/bpm to the response with the 200 status

      response-required-property-added

    • added the required property video/items/catalog to the response with the 200 status

      response-required-property-added

    • added the required property podcast_episode/items/last_played to the response with the 200 status

      response-required-property-added

    • added the required property song/items/last_played to the response with the 200 status

      response-required-property-added

    • added the required property video/items/last_played to the response with the 200 status

      response-required-property-added

    • api operation id bookmarkEditVideos was added

      api-operation-id-added

    • added optional request body

      request-body-added-optional

    • the query request parameter position became optional

      request-parameter-became-optional

    • added the non-success response with the status 401

      response-non-success-status-added

    • added the non-success response with the status 403

      response-non-success-status-added

    • added the non-success response with the status 404

      response-non-success-status-added

    • added the non-success response with the status 500

      response-non-success-status-added

    • added the optional property podcast_episode to the response with the 200 status

      response-optional-property-added

    • added the optional property song to the response with the 200 status

      response-optional-property-added

    • added the optional property video to the response with the 200 status

      response-optional-property-added

    • added the required property client to the response with the 200 status

      response-required-property-added

    • added the required property creation_date to the response with the 200 status

      response-required-property-added

    • added the required property id to the response with the 200 status

      response-required-property-added

    • added the required property object_id to the response with the 200 status

      response-required-property-added

    • added the required property object_type to the response with the 200 status

      response-required-property-added

    • added the required property owner to the response with the 200 status

      response-required-property-added

    • added the required property position to the response with the 200 status

      response-required-property-added

    • added the required property update_date to the response with the 200 status

      response-required-property-added

    • removed the non-success response with the status 400

      response-non-success-status-removed

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the non-success response with the status 400

      response-non-success-status-added

    • endpoint added

      endpoint-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • api path removed without deprecation

      api-path-removed-without-deprecation