Overview

Sections

Theme switcher

Replace Queue

Header Parameters

Authorizationstring

Credentials with queue:write scope

StoreIdstring

StoreId API Key provided by Tuned Global for accessing the service

Body Parameters

UserIdinteger Required

Id of the user

RepeatModestring Required

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

Show child attributes

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

Response

200
Object

OK

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

Show child attributes

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

Was this section helpful?

PUT

/

Select
1

Response

Was this section helpful?