Change category group assignments of an existing standard playlist version item

  • Published on Jan 24, 2025
  • 1 minute(s) reading time
Prev Next
Put
/v{version}/PlaylistVersions/{playlistVersionId}/Items/{itemId}/CategoryGroups

If Location is not set, it will not be returned If no category is assigned, then Categories will return an empty array.

Security
API Key
Header parameter nameX-ApiKey

Api Key

API Key
Header parameter nameX-Session-Id

Session Id

Path parameters
itemId
integer (int32) Required

Unique ID of the playlist version item

playlistVersionId
integer (int32) Required

Unique ID of the playlist version

version
stringRequired

The requested API version

Default"1.18"
Body parameters

Requested location IDs containing the new category group assignments for the specific playlist version item

Array of object
object

Category group assignment

Categories
Array of object (V1.Models.Playlist.Version.CategoryGroup.CategoryCategory)

Categories linked to the category group

object

Category category group

Id
integer (int32)

Unique ID of the category

Id
integer (int32)

Unique ID of the category group

IsNegated
boolean

If true, the category group is negated. Default: false.

Location
object (V1.Models.Playlist.Version.CategoryGroup.CategoryGroupLocation)

Location category group

Id
integer (int32)

Unique ID of the location

Responses
200

OK

Array of object
object

Category group assignment

Categories
Array of object (V1.Models.Playlist.Version.CategoryGroup.CategoryCategory)

Categories linked to the category group

object

Category category group

Id
integer (int32)

Unique ID of the category

Name
string

Name of the category

Id
integer (int32)

Unique ID of the category group

IsNegated
boolean

If true, the category group is negated. Default: false.

Location
object (V1.Models.Playlist.Version.CategoryGroup.CategoryGroupLocation)

Location category group

Id
integer (int32)

Unique ID of the location

Name
string

Name of the location

400

Bad request

Expand All
object
ValidationErrors
object
property*
Array of string additionalProperties
string
403

Access denied

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
500

Unexpected error

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties