Contents

Add resource to favorites

Add the user’s resource to favorites.

URL

POST https://api.music.apple.com/v1/me/favorites

Query Parameters

NameTypeDescription
ids Required[string]

The ids of the specific type.

l Optionalstring

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

Response Codes

StatusReasonTypeDescription
202Accepted
Content-Type: application/json
EmptyBodyResponse

Request accepted.

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 allows the user to favorite a resource. For example, if a customer favorites a song, the song is added to their favorite songs playlist. If they like an album or playlist, they can filter on favorited album in their library view.

If successful, the HTTP status code is 202 (Accepted) and there’s no response body. For requested IDs that the system can’t add to a user’s library, Apple Music Library ignores those IDs. If unsuccessful, the HTTP status code indicates the error and the details are in the errors array.