playlists

POST /playlists

Changed on

Creates a new playlist or album

Request

Query parameters

user_idstring required

The user ID of the user making the request

Request body

playlist_idstring

Optional playlist ID (will be generated if not provided)

playlist_namestring required

Playlist or album name

descriptionstring

Playlist description

is_privateboolean

Whether the playlist is private

is_albumboolean

Whether this is an album

genrestring

Music genre. Any string up to 100 characters is accepted. Known/canonical values (shown as autocomplete suggestions in clients): Electronic, Rock, Metal, Alternative, Hip-Hop/Rap, Experimental, Punk, Folk, Pop, Ambient, Soundtrack, World, Jazz, Acoustic, Funk, R&B/Soul, Devotional, Classical, Reggae, Podcasts, Country, Spoken Word, Comedy, Blues, Kids, Audiobooks, Latin, Lo-Fi, Hyperpop, Dancehall, Techno, Trap, House, Tech House, Deep House, Disco, Electro, Jungle, Progressive House, Hardstyle, Glitch Hop, Trance, Future Bass, Future House, Tropical House, Downtempo, Drum & Bass, Dubstep, Jersey Club, Vaporwave, Moombahton.

mood'Peaceful' | 'Romantic' | 'Sentimental' | 'Tender' | 'Easygoing' | 'Yearning' | 'Sophisticated' | 'Sensual' | 'Cool' | 'Gritty' | 'Melancholy' | 'Serious' | 'Brooding' | 'Fiery' | 'Defiant' | 'Aggressive' | 'Rowdy' | 'Excited' | 'Energizing' | 'Empowering' | 'Stirring' | 'Upbeat' | 'Other'

Music mood

tagsstring

Comma-separated tags

licensestring

License type

upcstring

Universal Product Code (for albums)

release_datestring date

Release date

playlist_image_sizes_multihashstring

CID for the playlist cover art

is_stream_gatedboolean nullable

Whether streaming is restricted behind an access gate

is_scheduled_releaseboolean nullable

Whether the playlist/album is a scheduled release

ddex_appstring

DDEX application identifier

ddex_release_idsobject nullable

DDEX release identifiers

parental_warning_typestring nullable

Parental warning type

is_image_autogeneratedboolean nullable

Whether the image is autogenerated

Example request

{
  "playlist_id": "x5pJ3Az",
  "playlist_name": "My New Playlist",
  "stream_conditions": {
    "usdc_purchase": {
      "splits": [
        {
          "user_id": 1234
        }
      ]
    }
  }
}

Response

Playlist created successfully

transaction_hashstring

The blockchain transaction hash

block_hashstring

The blockchain block hash

block_numberinteger

The blockchain block number/height

playlist_idstring

The ID of the created playlist

Changes

    • breaking

      removed the enum value Acoustic of the request property

    • breaking

      removed the enum value Alternative of the request property

    • breaking

      removed the enum value Ambient of the request property

    • breaking

      removed the enum value Audiobooks of the request property

    • breaking

      removed the enum value Blues of the request property

    • breaking

      removed the enum value Classical of the request property

    • breaking

      removed the enum value Comedy of the request property

    • breaking

      removed the enum value Country of the request property

    • breaking

      removed the enum value Dancehall of the request property

    • breaking

      removed the enum value Deep House of the request property

    • breaking

      removed the enum value Devotional of the request property

    • breaking

      removed the enum value Disco of the request property

    • breaking

      removed the enum value Downtempo of the request property

    • breaking

      removed the enum value Drum & Bass of the request property

    • breaking

      removed the enum value Dubstep of the request property

    • breaking

      removed the enum value Electro of the request property

    • breaking

      removed the enum value Electronic of the request property

    • breaking

      removed the enum value Experimental of the request property

    • breaking

      removed the enum value Folk of the request property

    • breaking

      removed the enum value Funk of the request property

    • breaking

      removed the enum value Future Bass of the request property

    • breaking

      removed the enum value Future House of the request property

    • breaking

      removed the enum value Glitch Hop of the request property

    • breaking

      removed the enum value Hardstyle of the request property

    • breaking

      removed the enum value Hip-Hop/Rap of the request property

    • breaking

      removed the enum value House of the request property

    • breaking

      removed the enum value Hyperpop of the request property

    • breaking

      removed the enum value Jazz of the request property

    • breaking

      removed the enum value Jersey Club of the request property

    • breaking

      removed the enum value Jungle of the request property

    • breaking

      removed the enum value Kids of the request property

    • breaking

      removed the enum value Latin of the request property

    • breaking

      removed the enum value Lo-Fi of the request property

    • breaking

      removed the enum value Metal of the request property

    • breaking

      removed the enum value Moombahton of the request property

    • breaking

      removed the enum value Podcasts of the request property

    • breaking

      removed the enum value Pop of the request property

    • breaking

      removed the enum value Progressive House of the request property

    • breaking

      removed the enum value Punk of the request property

    • breaking

      removed the enum value R&B/Soul of the request property

    • breaking

      removed the enum value Reggae of the request property

    • breaking

      removed the enum value Rock of the request property

    • breaking

      removed the enum value Soundtrack of the request property

    • breaking

      removed the enum value Spoken Word of the request property

    • breaking

      removed the enum value Tech House of the request property

    • breaking

      removed the enum value Techno of the request property

    • breaking

      removed the enum value Trance of the request property

    • breaking

      removed the enum value Trap of the request property

    • breaking

      removed the enum value Tropical House of the request property

    • breaking

      removed the enum value Vaporwave of the request property

    • breaking

      removed the enum value World of the request property

    • warning

      the request property's maxLength was set to 100

    • info

      endpoint added