Contents

Add a Resource to a Library

Add a catalog resource to a user’s iCloud Music Library.

URL

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

Query Parameters

NameTypeDescription
ids Required[string]

The unique catalog identifiers for the resources. To indicate the type of resource to add, follow the ids with one of the allowed values. Add multiple types in the same request.

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

Although the modification request was acceptable, it may not have completed.

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

If successful, the HTTP status code is 202 (Accepted) and there is no response body. For requested IDs that can’t be added 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.

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

Example

See Also

Related Documentation