Skip to content

Commit e8c4683

Browse files
rickyromborickyrombo
authored
Docs: Fix genre/mood, add missing playlist fields (#13793)
1 parent c1ec935 commit e8c4683

4 files changed

Lines changed: 135 additions & 77 deletions

File tree

‎docs/docs/developers/sdk/playlists.mdx‎

Lines changed: 51 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -535,24 +535,60 @@ Returns a `Promise` resolving to an object with the following fields:
535535

536536
### CreatePlaylistRequestBody
537537

538-
| Field | Type | Required | Description |
539-
| ------------------ | ----------------------------------------------------- | -------- | -------------------------------------------- |
540-
| `playlistName` | `string` | Yes | The name of the playlist |
541-
| `coverArt` | `string` | No | CID of the cover art image (use Uploads API) |
542-
| `description` | `string` | No | The playlist description |
543-
| `isAlbum` | `boolean` | No | Whether this is an album |
544-
| `isPrivate` | `boolean` | No | Whether the playlist is private |
545-
| `playlistContents` | [`PlaylistAddedTimestamp[]`](#playlistaddedtimestamp) | No | Array of tracks to include in the playlist |
538+
| Field | Type | Required | Description |
539+
| ----------------------- | ------------------------------------------------------------- | -------- | ----------------------------------------------------- |
540+
| `playlistName` | `string` | Yes | The name of the playlist |
541+
| `playlistId` | `string` | No | Optional playlist ID (auto-generated if not provided) |
542+
| `coverArtCid` | `string` | No | CID of the cover art image (from Uploads API) |
543+
| `description` | `string` | No | The playlist description |
544+
| `isAlbum` | `boolean` | No | Whether this is an album |
545+
| `isPrivate` | `boolean` | No | Whether the playlist is private |
546+
| `genre` | [`Genre`](tracks#genre-values) | No | Playlist/album genre |
547+
| `mood` | [`Mood`](tracks#mood-values) | No | Playlist/album mood |
548+
| `tags` | `string` | No | Comma-separated tags |
549+
| `license` | `string` | No | License type |
550+
| `upc` | `string` | No | Universal Product Code (for albums) |
551+
| `releaseDate` | `Date` | No | Release date |
552+
| `playlistContents` | [`PlaylistAddedTimestamp[]`](#playlistaddedtimestamp) | No | Array of tracks to include in the playlist |
553+
| `isStreamGated` | `boolean` | No | Whether streaming is behind an access gate |
554+
| `isScheduledRelease` | `boolean` | No | Whether this is a scheduled release |
555+
| `streamConditions` | [`AccessGate`](tracks#accessgate) | No | Conditions for stream access gating |
556+
| `ddexApp` | `string` | No | DDEX application identifier |
557+
| `ddexReleaseIds` | `object` | No | DDEX release identifiers |
558+
| `artists` | [`DdexResourceContributor[]`](tracks#ddexresourcecontributor) | No | DDEX resource contributors / artists |
559+
| `copyrightLine` | `object` | No | Copyright line |
560+
| `producerCopyrightLine` | `object` | No | Producer copyright line |
561+
| `parentalWarningType` | `string` | No | Parental warning type |
562+
| `isImageAutogenerated` | `boolean` | No | Whether the image is autogenerated |
546563

547564
### UpdatePlaylistRequestBody
548565

549-
| Field | Type | Required | Description |
550-
| ------------------ | ----------------------------------------------------- | -------- | ---------------------------------------------- |
551-
| `playlistName` | `string` | No | The name of the playlist |
552-
| `coverArt` | `string` | No | CID of the cover art image (use Uploads API) |
553-
| `description` | `string` | No | The playlist description |
554-
| `isPrivate` | `boolean` | No | Whether the playlist is private |
555-
| `playlistContents` | [`PlaylistAddedTimestamp[]`](#playlistaddedtimestamp) | No | Array of tracks in the playlist (replaces all) |
566+
All fields are optional — only include the fields you want to change.
567+
568+
| Field | Type | Required | Description |
569+
| ----------------------- | ------------------------------------------------------------- | -------- | ---------------------------------------------- |
570+
| `playlistName` | `string` | No | The name of the playlist |
571+
| `coverArtCid` | `string` | No | CID of the cover art image (from Uploads API) |
572+
| `description` | `string` | No | The playlist description |
573+
| `isAlbum` | `boolean` | No | Whether this is an album |
574+
| `isPrivate` | `boolean` | No | Whether the playlist is private |
575+
| `genre` | [`Genre`](tracks#genre-values) | No | Playlist/album genre |
576+
| `mood` | [`Mood`](tracks#mood-values) | No | Playlist/album mood |
577+
| `tags` | `string` | No | Comma-separated tags |
578+
| `license` | `string` | No | License type |
579+
| `upc` | `string` | No | Universal Product Code (for albums) |
580+
| `releaseDate` | `Date` | No | Release date |
581+
| `playlistContents` | [`PlaylistAddedTimestamp[]`](#playlistaddedtimestamp) | No | Array of tracks in the playlist (replaces all) |
582+
| `isStreamGated` | `boolean` | No | Whether streaming is behind an access gate |
583+
| `isScheduledRelease` | `boolean` | No | Whether this is a scheduled release |
584+
| `streamConditions` | [`AccessGate`](tracks#accessgate) | No | Conditions for stream access gating |
585+
| `ddexApp` | `string` | No | DDEX application identifier |
586+
| `ddexReleaseIds` | `object` | No | DDEX release identifiers |
587+
| `artists` | [`DdexResourceContributor[]`](tracks#ddexresourcecontributor) | No | DDEX resource contributors / artists |
588+
| `copyrightLine` | `object` | No | Copyright line |
589+
| `producerCopyrightLine` | `object` | No | Producer copyright line |
590+
| `parentalWarningType` | `string` | No | Parental warning type |
591+
| `isImageAutogenerated` | `boolean` | No | Whether the image is autogenerated |
556592

557593
### PlaylistAddedTimestamp
558594

0 commit comments

Comments
 (0)