createCollection

Creates a collection.

http://your-server/rest/createCollection

Creates a collection. This endpoint must be accessed using an HTTP POST request.

Request Body

The request payload should be provided in the body as a JSON object, as specified by the CreateCollectionRequest schema.

{
  "name": "test collection",
  "comment": "this is a collection",
  "items": [
    {
      "type": "song",
      "id": "300000060"
    },
    {
      "type": "album",
      "id": "200000021"
    },
    {
      "type": "genre",
      "id": "vaporwave"
    }
  ]
}

Example request

Result

A subsonic-response element with a top-level collection object on success. In case of an error, a standard HTTP error code is returned with a descriptive message.

{
  "subsonic-response": {
    "status": "ok",
    "version": "1.16.1",
    "type": "AwesomeServerName",
    "serverVersion": "0.1.3 (tag)",
    "openSubsonic": true,
    "collection": {
      "id": "800000075",
      "name": "test collection",
      "comment" "this is a collection",
      "owner": "user",
      "public": false,
      "itemCount": 3,
      "created": "2023-03-16T03:18:41+00:00",
      "changed": "2023-03-16T03:18:41+00:00"
    }
  }
}
FieldTypeReq.OpenS.Details
collectionCollectionYesThe collection