Skip to content
DocumentationAPI Reference

Update Playlist Items

TrackUpdateResponse playlists().tracks().update(TrackUpdateParamsparams = TrackUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
PUT/playlists/{playlist_id}/tracks

Either reorder or replace items in a playlist depending on the request's parameters. To reorder items, include range_start, insert_before, range_length and snapshot_id in the request's body. To replace items, include uris as either a query parameter or in the request's body. Replacing items in a playlist will overwrite its existing items. This operation can be used for replacing or clearing items in a playlist.
Note: Replace and reorder are mutually exclusive operations which share the same endpoint, but have different parameters. These operations can't be applied together in a single request.

ParametersExpand Collapse
TrackUpdateParams params
Optional<String> playlistId

The Spotify ID of the playlist.

Optional<Long> insertBefore

The position where the items should be inserted.
To reorder the items to the end of the playlist, simply set insert_before to the position after the last item.
Examples:
To reorder the first item to the last position in a playlist with 10 items, set range_start to 0, and insert_before to 10.
To reorder the last item in a playlist with 10 items to the start of the playlist, set range_start to 9, and insert_before to 0.

Optional<Boolean> published

The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists

Optional<Long> rangeLength

The amount of items to be reordered. Defaults to 1 if not set.
The range of items to be reordered begins from the range_start position, and includes the range_length subsequent items.
Example:
To move the items at index 9-10 to the start of the playlist, range_start is set to 9, and range_length is set to 2.

Optional<Long> rangeStart

The position of the first item to be reordered.

Optional<String> snapshotId

The playlist's snapshot ID against which you want to make the changes.

Optional<List<String>> uris
ReturnsExpand Collapse
class TrackUpdateResponse:
Optional<String> snapshotId

Update Playlist Items

package dev.cjav.spotted.example;

import dev.cjav.spotted.client.SpottedClient;
import dev.cjav.spotted.client.okhttp.SpottedOkHttpClient;
import dev.cjav.spotted.models.playlists.tracks.TrackUpdateParams;
import dev.cjav.spotted.models.playlists.tracks.TrackUpdateResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        SpottedClient client = SpottedOkHttpClient.fromEnv();

        TrackUpdateResponse track = client.playlists().tracks().update("3cEYpjA9oz9GiPac4AsH4n");
    }
}
{
  "snapshot_id": "abc"
}
Returns Examples
{
  "snapshot_id": "abc"
}