Contents

Add a Personal Library Music Video Rating

Add a user’s library music video rating by using the library music video’s identifier.

URL

PUT https://api.music.apple.com/v1/me/ratings/library-music-videos/{id}

Path Parameters

NameTypeDescription
id Requiredstring

The unique identifier for the library music video.

Query Parameters

NameTypeDescription
l Optionalstring

The localization to use, specified by a language tag. The possible values are in the supportedLanguageTags array belonging to the Storefront object specified by storefront. Otherwise, the default is defaultLanguageTag in Storefront.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
RatingsResponse

The request was successful.

401Unauthorized
Content-Type: application/json
UnauthorizedResponse

A response indicating an incorrect Authorization header.

403Forbidden
Content-Type: application/json
ForbiddenResponse

A response indicating invalid or insufficient authentication.

500Internal Server Error
Content-Type: application/json
ErrorsResponse

A response indicating an error occurred on the server.

Discussion

This endpoint requires a music user token. For more information, see User Authentication for MusicKit.

A rating indicates whether a user likes (1) or dislikes (-1) the music video. These are the only two ratings supported.

For a particular music video, the personal rating for that video’s catalog ID and library ID (if the video is in the library) stay synced.

Example

HTTP Body

A dictionary that includes the type and attributes of the resource rating.

See Also

Related Documentation

Adding Library Ratings