Playlist

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "description": "A studio music playlist.",
  "properties": {
    "created": {
      "description": "The creation date of this playlist.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "id": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Id"
        },
        {
          "readOnly": true
        }
      ]
    },
    "isEditable": {
      "description": "Flag indicating whether the playlist is editable by the studio. Playlists created by the\nstudio have a true value here, playlists created by the system (ie: featured playlists) are\nfalse. If this value is true, the playlist can be neither edited or deleted by the studio via\nthe API. If this value is false, submitting an update to this playlist will result in a 400\nwith validation errors.",
      "readOnly": true,
      "type": "boolean"
    },
    "name": {
      "description": "The playlist name.",
      "type": "string"
    },
    "songCount": {
      "description": "The number of songs appearing in the playlist.",
      "readOnly": true,
      "type": "integer"
    },
    "songs": {
      "description": "The songs in the playlist, represented by their ID. The Ultimate music plan supports addition\nof up to 20 songs in a playlist. The limited music plans support addition of 3 songs in a\nplaylist. Submitting more songs than the subscribed plan supports will result in a 400 with\nvalidation errors.",
      "items": {
        "description": "A song, represented by its ID",
        "properties": {
          "id": {
            "$ref": "#/components/schemas/Id"
          },
          "type": {
            "description": "The type of object represented.",
            "enum": [
              "song"
            ],
            "type": "string"
          }
        },
        "required": [
          "type",
          "id"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "type": {
      "description": "The type of object represented.",
      "enum": [
        "playlist"
      ],
      "type": "string"
    }
  },
  "required": [
    "type",
    "name"
  ],
  "title": "A music playlist.",
  "type": "object"
}