Overview

Remove Groups

Removes every track group from the signed-in user's Now Playing queue in one call, clearing all source section headers at once. Returns the updated full queue; how remaining track entries are handled depends on your client implementation.

Use this when: clearing all source groupings, such as a "Clear queue" action that removes section headers. Use Remove Group to drop one album or playlist section, or Remove Tracks to delete specific items by PlayQueueItemId. For a complete reset including tracks and settings, Replace Queue with an empty snapshot may be simpler.

Security Model

oAuth

Header Parameters

Authorizationstring Required

Credentials with queue:read and queue:write scopes.

StoreIdstring Required

StoreId API Key provided by Tuned Global for accessing the service.

Response

200

Object

Response Attributes

UserIdinteger

Id of the user

RepeatModestring

Has the user turned on any of the repeat/loop modes?

Enum values:

OffRepeatAllRepeatOne

IsShuffleModeboolean

Has the user turned on shuffle?

IsCrossfadeModeboolean

Has the user turned on crossfade?

Groupsarray

List of groups of tracks that have been queued.

Show child attributes

Tracksarray

The tracks in the group

Show child attributes

CurrentlyPlayingobject

Which song within any of the Groups is currently playing, if any

ShuffleOrderarray

When shuffle mode is turned on, ShuffleOrder is populated with the list of unique ids of queue items in the shuffled order they are to be played in. Cleared when shuffle mode is disabled.

Show child attributes

EditVersioninteger

Version number for the queue that gets incremented every time the queue changes

Sections

Remove Groups

Security Model

Header Parameters

ResponseExpand all

Response Attributes

Response

Response