Products

Albums and releases management.

List products

GET

https://api.idol.io/api/v2

/products

Retrieve a paginated list of products

List products › query Parameters

page[number]

integer · min: 1

Page number for pagination

Default: 1

page[size]

integer · min: 1 · max: 200

Number of items per page (max 200)

Default: 20

include

string

Comma-separated list of related resources to include

sort

string

Comma-separated list of fields to sort by (prefix with - for descending)

filter[distributor-id]

string

Filter by distributor ID

filter[company-ids]

string

Comma-separated company IDs

filter[label-ids]

string

Comma-separated label IDs

filter[product-genre-ids]

string

Comma-separated product genre IDs

filter[distributor-product-subgenre-ids]

string

Comma-separated distributor product subgenre IDs

filter[statuses]

string

Comma-separated list of statuses (draft, reviewing, active, archived)

filter[upc-code]

string

Filter by UPC code

List products › Responses

Successful response

ProductListResponse

ProductResource[]

Array of resource objects (override with specific resource schema)

object[]

Related resources included in the response

PaginationMeta

PaginationLinks

GET/products

curl https://api.idol.io/api/v2/products \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "type": "products",
      "id": "id",
      "attributes": {
        "name": "name",
        "artist": [
          "string"
        ],
        "contributor": [
          "string"
        ],
        "featuring": [
          "string"
        ],
        "remixer": [
          "string"
        ],
        "composer": [
          "string"
        ],
        "author": [
          "string"
        ],
        "upc-code": "upc-code",
        "label-internal-reference": "label-internal-reference",
        "release-date": "2024-08-25",
        "original-release-date": "2024-08-25",
        "subtitle": "subtitle",
        "front-cover": "front-cover",
        "copyright-line": "copyright-line",
        "production-line": "production-line",
        "production-year": 0,
        "status": "draft",
        "is-compilation": true,
        "booklet-url": "https://www.example.com/path/to/resource",
        "cover-url": "https://www.example.com/path/to/resource",
        "created-at": "2024-08-25T15:00:00Z",
        "updated-at": "2024-08-25T15:00:00Z",
        "default-offer-validation": true,
        "is-active": true,
        "prod-comments": "prod-comments",
        "label-comments": "label-comments",
        "is-mfit": true,
        "audio16bits": true,
        "audio24bits": true,
        "all16bits": true,
        "all24bits": true,
        "mastered-by": "mastered-by",
        "booklet": "booklet",
        "cover-ai-contribution": "undeclared"
      },
      "relationships": {
        "distributor": {
          "data": {
            "type": "type",
            "id": "id"
          },
          "links": {
            "self": "https://www.example.com/path/to/resource",
            "related": "https://www.example.com/path/to/resource"
          }
        },
        "company": {
          "data": {
            "type": "type",
            "id": "id"
          },
          "links": {
            "self": "https://www.example.com/path/to/resource",
            "related": "https://www.example.com/path/to/resource"
          }
        },
        "label": {
          "data": {
            "type": "type",
            "id": "id"
          },
          "links": {
            "self": "https://www.example.com/path/to/resource",
            "related": "https://www.example.com/path/to/resource"
          }
        },
        "product-type": {
          "data": {
            "type": "type",
            "id": "id"
          },
          "links": {
            "self": "https://www.example.com/path/to/resource",
            "related": "https://www.example.com/path/to/resource"
          }
        },
        "default-offer": {
          "data": {
            "type": "type",
            "id": "id"
          },
          "links": {
            "self": "https://www.example.com/path/to/resource",
            "related": "https://www.example.com/path/to/resource"
          }
        },
        "tracks": {
          "data": [
            {
              "type": "type",
              "id": "id"
            }
          ],
          "links": {
            "self": "https://www.example.com/path/to/resource",
            "related": "https://www.example.com/path/to/resource"
          },
          "meta": {}
        },
        "offers": {
          "data": [
            {
              "type": "type",
              "id": "id"
            }
          ],
          "links": {
            "self": "https://www.example.com/path/to/resource",
            "related": "https://www.example.com/path/to/resource"
          },
          "meta": {}
        },
        "submissions": {
          "data": [
            {
              "type": "type",
              "id": "id"
            }
          ],
          "links": {
            "self": "https://www.example.com/path/to/resource",
            "related": "https://www.example.com/path/to/resource"
          },
          "meta": {}
        },
        "rights": {
          "data": [
            {
              "type": "type",
              "id": "id"
            }
          ],
          "links": {
            "self": "https://www.example.com/path/to/resource",
            "related": "https://www.example.com/path/to/resource"
          },
          "meta": {}
        },
        "performers": {
          "data": [
            {
              "type": "type",
              "id": "id"
            }
          ],
          "links": {
            "self": "https://www.example.com/path/to/resource",
            "related": "https://www.example.com/path/to/resource"
          },
          "meta": {}
        },
        "tags": {
          "data": [
            {
              "type": "type",
              "id": "id"
            }
          ],
          "links": {
            "self": "https://www.example.com/path/to/resource",
            "related": "https://www.example.com/path/to/resource"
          },
          "meta": {}
        },
        "authors": {
          "data": [
            {
              "type": "type",
              "id": "id"
            }
          ],
          "links": {
            "self": "https://www.example.com/path/to/resource",
            "related": "https://www.example.com/path/to/resource"
          },
          "meta": {}
        },
        "composers": {
          "data": [
            {
              "type": "type",
              "id": "id"
            }
          ],
          "links": {
            "self": "https://www.example.com/path/to/resource",
            "related": "https://www.example.com/path/to/resource"
          },
          "meta": {}
        },
        "contributors": {
          "data": [
            {
              "type": "type",
              "id": "id"
            }
          ],
          "links": {
            "self": "https://www.example.com/path/to/resource",
            "related": "https://www.example.com/path/to/resource"
          },
          "meta": {}
        },
        "remixers": {
          "data": [
            {
              "type": "type",
              "id": "id"
            }
          ],
          "links": {
            "self": "https://www.example.com/path/to/resource",
            "related": "https://www.example.com/path/to/resource"
          },
          "meta": {}
        },
        "featuring": {
          "data": [
            {
              "type": "type",
              "id": "id"
            }
          ],
          "links": {
            "self": "https://www.example.com/path/to/resource",
            "related": "https://www.example.com/path/to/resource"
          },
          "meta": {}
        }
      },
      "links": {
        "self": "https://www.example.com/path/to/resource"
      }
    }
  ],
  "included": [
    {}
  ],
  "meta": {
    "record-count": 0,
    "page-count": 0
  },
  "links": {
    "first": "https://www.example.com/path/to/resource",
    "last": "https://www.example.com/path/to/resource",
    "prev": "https://www.example.com/path/to/resource",
    "next": "https://www.example.com/path/to/resource"
  }
}

json

application/vnd.api+json

Create a product

POST

https://api.idol.io/api/v2

/products

Create a new Product (Album/Single/EP/Video)

Create a product › Request Body

ProductCreateRequest

ProductResource · required

Create a product › Responses

Product created successfully

ProductResponse

ProductResource

The primary resource object (override with specific resource schema)

object[]

Related resources included in the response

object

POST/products

curl https://api.idol.io/api/v2/products \
  --request POST \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "data": {
    "type": "products",
    "id": "id",
    "attributes": {
      "name": "name",
      "artist": [
        "string"
      ],
      "contributor": [
        "string"
      ],
      "featuring": [
        "string"
      ],
      "remixer": [
        "string"
      ],
      "composer": [
        "string"
      ],
      "author": [
        "string"
      ],
      "upc-code": "upc-code",
      "label-internal-reference": "label-internal-reference",
      "release-date": "2024-08-25",
      "original-release-date": "2024-08-25",
      "subtitle": "subtitle",
      "front-cover": "front-cover",
      "copyright-line": "copyright-line",
      "production-line": "production-line",
      "production-year": 0,
      "status": "draft",
      "is-compilation": true,
      "booklet-url": "https://www.example.com/path/to/resource",
      "cover-url": "https://www.example.com/path/to/resource",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z",
      "default-offer-validation": true,
      "is-active": true,
      "prod-comments": "prod-comments",
      "label-comments": "label-comments",
      "is-mfit": true,
      "audio16bits": true,
      "audio24bits": true,
      "all16bits": true,
      "all24bits": true,
      "mastered-by": "mastered-by",
      "booklet": "booklet",
      "cover-ai-contribution": "undeclared"
    },
    "relationships": {
      "distributor": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "company": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "label": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "product-type": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "default-offer": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "tracks": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "offers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "submissions": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "rights": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "performers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "tags": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "authors": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "composers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "contributors": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "remixers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "featuring": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    },
    "links": {
      "self": "https://www.example.com/path/to/resource"
    }
  }
}'

Example Request Body

{
  "data": {
    "type": "products",
    "id": "id",
    "attributes": {
      "name": "name",
      "artist": [
        "string"
      ],
      "contributor": [
        "string"
      ],
      "featuring": [
        "string"
      ],
      "remixer": [
        "string"
      ],
      "composer": [
        "string"
      ],
      "author": [
        "string"
      ],
      "upc-code": "upc-code",
      "label-internal-reference": "label-internal-reference",
      "release-date": "2024-08-25",
      "original-release-date": "2024-08-25",
      "subtitle": "subtitle",
      "front-cover": "front-cover",
      "copyright-line": "copyright-line",
      "production-line": "production-line",
      "production-year": 0,
      "status": "draft",
      "is-compilation": true,
      "booklet-url": "https://www.example.com/path/to/resource",
      "cover-url": "https://www.example.com/path/to/resource",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z",
      "default-offer-validation": true,
      "is-active": true,
      "prod-comments": "prod-comments",
      "label-comments": "label-comments",
      "is-mfit": true,
      "audio16bits": true,
      "audio24bits": true,
      "all16bits": true,
      "all24bits": true,
      "mastered-by": "mastered-by",
      "booklet": "booklet",
      "cover-ai-contribution": "undeclared"
    },
    "relationships": {
      "distributor": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "company": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "label": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "product-type": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "default-offer": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "tracks": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "offers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "submissions": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "rights": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "performers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "tags": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "authors": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "composers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "contributors": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "remixers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "featuring": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    },
    "links": {
      "self": "https://www.example.com/path/to/resource"
    }
  }
}

json

Example Responses

{
  "data": {
    "type": "products",
    "id": "id",
    "attributes": {
      "name": "name",
      "artist": [
        "string"
      ],
      "contributor": [
        "string"
      ],
      "featuring": [
        "string"
      ],
      "remixer": [
        "string"
      ],
      "composer": [
        "string"
      ],
      "author": [
        "string"
      ],
      "upc-code": "upc-code",
      "label-internal-reference": "label-internal-reference",
      "release-date": "2024-08-25",
      "original-release-date": "2024-08-25",
      "subtitle": "subtitle",
      "front-cover": "front-cover",
      "copyright-line": "copyright-line",
      "production-line": "production-line",
      "production-year": 0,
      "status": "draft",
      "is-compilation": true,
      "booklet-url": "https://www.example.com/path/to/resource",
      "cover-url": "https://www.example.com/path/to/resource",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z",
      "default-offer-validation": true,
      "is-active": true,
      "prod-comments": "prod-comments",
      "label-comments": "label-comments",
      "is-mfit": true,
      "audio16bits": true,
      "audio24bits": true,
      "all16bits": true,
      "all24bits": true,
      "mastered-by": "mastered-by",
      "booklet": "booklet",
      "cover-ai-contribution": "undeclared"
    },
    "relationships": {
      "distributor": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "company": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "label": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "product-type": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "default-offer": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "tracks": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "offers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "submissions": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "rights": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "performers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "tags": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "authors": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "composers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "contributors": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "remixers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "featuring": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    },
    "links": {
      "self": "https://www.example.com/path/to/resource"
    }
  },
  "included": [
    {}
  ],
  "links": {
    "self": "https://www.example.com/path/to/resource"
  }
}

json

application/vnd.api+json

Get product details

GET

https://api.idol.io/api/v2

/products/{id}

Retrieve a single product by ID

Get product details › path Parameters

id

string · required

Resource ID

Get product details › query Parameters

include

string

Comma-separated list of related resources to include

fields[products]

string

Comma-separated list of fields to include (sparse fieldsets)

Get product details › Responses

Successful response

ProductResponse

ProductResource

The primary resource object (override with specific resource schema)

object[]

Related resources included in the response

object

GET/products/{id}

curl https://api.idol.io/api/v2/products/:id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": {
    "type": "products",
    "id": "id",
    "attributes": {
      "name": "name",
      "artist": [
        "string"
      ],
      "contributor": [
        "string"
      ],
      "featuring": [
        "string"
      ],
      "remixer": [
        "string"
      ],
      "composer": [
        "string"
      ],
      "author": [
        "string"
      ],
      "upc-code": "upc-code",
      "label-internal-reference": "label-internal-reference",
      "release-date": "2024-08-25",
      "original-release-date": "2024-08-25",
      "subtitle": "subtitle",
      "front-cover": "front-cover",
      "copyright-line": "copyright-line",
      "production-line": "production-line",
      "production-year": 0,
      "status": "draft",
      "is-compilation": true,
      "booklet-url": "https://www.example.com/path/to/resource",
      "cover-url": "https://www.example.com/path/to/resource",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z",
      "default-offer-validation": true,
      "is-active": true,
      "prod-comments": "prod-comments",
      "label-comments": "label-comments",
      "is-mfit": true,
      "audio16bits": true,
      "audio24bits": true,
      "all16bits": true,
      "all24bits": true,
      "mastered-by": "mastered-by",
      "booklet": "booklet",
      "cover-ai-contribution": "undeclared"
    },
    "relationships": {
      "distributor": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "company": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "label": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "product-type": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "default-offer": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "tracks": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "offers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "submissions": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "rights": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "performers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "tags": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "authors": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "composers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "contributors": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "remixers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "featuring": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    },
    "links": {
      "self": "https://www.example.com/path/to/resource"
    }
  },
  "included": [
    {}
  ],
  "links": {
    "self": "https://www.example.com/path/to/resource"
  }
}

json

application/vnd.api+json

Update a product

PUT

https://api.idol.io/api/v2

/products/{id}

Update an existing product

Update a product › path Parameters

id

string · required

Resource ID

Update a product › Request Body

ProductUpdateRequest

ProductResource · required

Update a product › Responses

Product updated successfully

ProductResponse

ProductResource

The primary resource object (override with specific resource schema)

object[]

Related resources included in the response

object

PUT/products/{id}

curl https://api.idol.io/api/v2/products/:id \
  --request PUT \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "data": {
    "type": "products",
    "id": "id",
    "attributes": {
      "name": "name",
      "artist": [
        "string"
      ],
      "contributor": [
        "string"
      ],
      "featuring": [
        "string"
      ],
      "remixer": [
        "string"
      ],
      "composer": [
        "string"
      ],
      "author": [
        "string"
      ],
      "upc-code": "upc-code",
      "label-internal-reference": "label-internal-reference",
      "release-date": "2024-08-25",
      "original-release-date": "2024-08-25",
      "subtitle": "subtitle",
      "front-cover": "front-cover",
      "copyright-line": "copyright-line",
      "production-line": "production-line",
      "production-year": 0,
      "status": "draft",
      "is-compilation": true,
      "booklet-url": "https://www.example.com/path/to/resource",
      "cover-url": "https://www.example.com/path/to/resource",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z",
      "default-offer-validation": true,
      "is-active": true,
      "prod-comments": "prod-comments",
      "label-comments": "label-comments",
      "is-mfit": true,
      "audio16bits": true,
      "audio24bits": true,
      "all16bits": true,
      "all24bits": true,
      "mastered-by": "mastered-by",
      "booklet": "booklet",
      "cover-ai-contribution": "undeclared"
    },
    "relationships": {
      "distributor": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "company": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "label": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "product-type": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "default-offer": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "tracks": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "offers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "submissions": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "rights": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "performers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "tags": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "authors": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "composers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "contributors": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "remixers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "featuring": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    },
    "links": {
      "self": "https://www.example.com/path/to/resource"
    }
  }
}'

Example Request Body

{
  "data": {
    "type": "products",
    "id": "id",
    "attributes": {
      "name": "name",
      "artist": [
        "string"
      ],
      "contributor": [
        "string"
      ],
      "featuring": [
        "string"
      ],
      "remixer": [
        "string"
      ],
      "composer": [
        "string"
      ],
      "author": [
        "string"
      ],
      "upc-code": "upc-code",
      "label-internal-reference": "label-internal-reference",
      "release-date": "2024-08-25",
      "original-release-date": "2024-08-25",
      "subtitle": "subtitle",
      "front-cover": "front-cover",
      "copyright-line": "copyright-line",
      "production-line": "production-line",
      "production-year": 0,
      "status": "draft",
      "is-compilation": true,
      "booklet-url": "https://www.example.com/path/to/resource",
      "cover-url": "https://www.example.com/path/to/resource",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z",
      "default-offer-validation": true,
      "is-active": true,
      "prod-comments": "prod-comments",
      "label-comments": "label-comments",
      "is-mfit": true,
      "audio16bits": true,
      "audio24bits": true,
      "all16bits": true,
      "all24bits": true,
      "mastered-by": "mastered-by",
      "booklet": "booklet",
      "cover-ai-contribution": "undeclared"
    },
    "relationships": {
      "distributor": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "company": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "label": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "product-type": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "default-offer": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "tracks": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "offers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "submissions": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "rights": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "performers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "tags": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "authors": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "composers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "contributors": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "remixers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "featuring": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    },
    "links": {
      "self": "https://www.example.com/path/to/resource"
    }
  }
}

json

Example Responses

{
  "data": {
    "type": "products",
    "id": "id",
    "attributes": {
      "name": "name",
      "artist": [
        "string"
      ],
      "contributor": [
        "string"
      ],
      "featuring": [
        "string"
      ],
      "remixer": [
        "string"
      ],
      "composer": [
        "string"
      ],
      "author": [
        "string"
      ],
      "upc-code": "upc-code",
      "label-internal-reference": "label-internal-reference",
      "release-date": "2024-08-25",
      "original-release-date": "2024-08-25",
      "subtitle": "subtitle",
      "front-cover": "front-cover",
      "copyright-line": "copyright-line",
      "production-line": "production-line",
      "production-year": 0,
      "status": "draft",
      "is-compilation": true,
      "booklet-url": "https://www.example.com/path/to/resource",
      "cover-url": "https://www.example.com/path/to/resource",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z",
      "default-offer-validation": true,
      "is-active": true,
      "prod-comments": "prod-comments",
      "label-comments": "label-comments",
      "is-mfit": true,
      "audio16bits": true,
      "audio24bits": true,
      "all16bits": true,
      "all24bits": true,
      "mastered-by": "mastered-by",
      "booklet": "booklet",
      "cover-ai-contribution": "undeclared"
    },
    "relationships": {
      "distributor": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "company": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "label": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "product-type": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "default-offer": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "tracks": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "offers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "submissions": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "rights": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "performers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "tags": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "authors": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "composers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "contributors": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "remixers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "featuring": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    },
    "links": {
      "self": "https://www.example.com/path/to/resource"
    }
  },
  "included": [
    {}
  ],
  "links": {
    "self": "https://www.example.com/path/to/resource"
  }
}

json

application/vnd.api+json

Delete a product

DELETE

https://api.idol.io/api/v2

/products/{id}

Delete a product.

Important: Products can only be deleted if status is "draft" or "reviewing" and has no associated DspStates.

Delete a product › path Parameters

id

string · required

Resource ID

Delete a product › Responses

Product deleted successfully

No data returned

Labels Tracks