Skip to main content
PUT
/
catalog-import
/
items
/
{id}
Set reviewer overrides on a pending staged item
curl --request PUT \
  --url https://api.royalti.io/catalog-import/items/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "finalData": {
    "title": "Corrected Title",
    "iswc": "T-034524680-1"
  },
  "artists": {
    "Jane Doe": "primary",
    "Guest Artist": "featuring"
  }
}
'
import requests

url = "https://api.royalti.io/catalog-import/items/{id}"

payload = {
"finalData": {
"title": "Corrected Title",
"iswc": "T-034524680-1"
},
"artists": {
"Jane Doe": "primary",
"Guest Artist": "featuring"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
finalData: {title: 'Corrected Title', iswc: 'T-034524680-1'},
artists: {'Jane Doe': 'primary', 'Guest Artist': 'featuring'}
})
};

fetch('https://api.royalti.io/catalog-import/items/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.royalti.io/catalog-import/items/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'finalData' => [
'title' => 'Corrected Title',
'iswc' => 'T-034524680-1'
],
'artists' => [
'Jane Doe' => 'primary',
'Guest Artist' => 'featuring'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.royalti.io/catalog-import/items/{id}"

payload := strings.NewReader("{\n \"finalData\": {\n \"title\": \"Corrected Title\",\n \"iswc\": \"T-034524680-1\"\n },\n \"artists\": {\n \"Jane Doe\": \"primary\",\n \"Guest Artist\": \"featuring\"\n }\n}")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://api.royalti.io/catalog-import/items/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"finalData\": {\n \"title\": \"Corrected Title\",\n \"iswc\": \"T-034524680-1\"\n },\n \"artists\": {\n \"Jane Doe\": \"primary\",\n \"Guest Artist\": \"featuring\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/catalog-import/items/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"finalData\": {\n \"title\": \"Corrected Title\",\n \"iswc\": \"T-034524680-1\"\n },\n \"artists\": {\n \"Jane Doe\": \"primary\",\n \"Guest Artist\": \"featuring\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "message": "Import item updated",
  "data": {
    "item": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "TenantId": 123,
      "batchId": "<string>",
      "targetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "isrc": "<string>",
      "upc": "<string>",
      "rawTitle": "<string>",
      "rawArtist": "<string>",
      "rawLabel": "<string>",
      "rawAggregator": "<string>",
      "rawTracklist": "<string>",
      "rawMetadata": {},
      "enrichedTitle": "<string>",
      "enrichedArtist": "<string>",
      "enrichedGenre": [
        "<string>"
      ],
      "enrichedDuration": 123,
      "enrichedReleaseDate": "<string>",
      "enrichedLabel": "<string>",
      "enrichedAlbumArt": "<string>",
      "enrichmentConfidence": 0.5,
      "artists": {
        "Burna Boy": "primary",
        "Wizkid": "featuring"
      },
      "finalData": {},
      "createdItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "importError": "<string>",
      "reviewedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "reviewedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  }
}
{
"status": "error",
"message": "Provide finalData and/or artists to update"
}
{
"status": "error",
"message": "<string>",
"code": "<string>",
"details": {}
}
{
"status": "error",
"message": "Insufficient permissions. Admin access required."
}
{
"status": "error",
"message": "Import item not found or not pending"
}
{
"status": "error",
"message": "Internal server error"
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

PUT /catalog-import/items/ Description: Applies reviewer-supplied overrides to a single pending, metadata-engine-sourced staged item before it is applied. finalData is merged into the item’s existing finalData (not replaced), and only a fixed allowlist of fields is accepted — title, displayArtist, mainGenre, explicit, recordingDate, label, format, albumArt, iswc, releaseDate, version, catalogNumber; any other key is silently dropped. artists replaces the item’s artist-role map outright. This is the only way to resolve a conflict-kind diff entry, since conflicting incoming values never auto-apply. Authorization:
  • Required role: admin or higher
Method: PUT

Code Examples

const response = await fetch('https://api.royalti.io/catalog-import/items/example-id', {
  method: 'PUT',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "ref": "#/components/schemas/UpdateItemRequest"
  })
});

const data = await response.json();
console.log(data);
import requests

response = requests.put(
  'https://api.royalti.io/catalog-import/items/example-id',
  headers={
    'Authorization': f'Bearer {token}'
  },
  json={"ref":"#/components/schemas/UpdateItemRequest"}
)

data = response.json()
print(data)
curl -X PUT https://api.royalti.io/catalog-import/items/example-id \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ref":"#/components/schemas/UpdateItemRequest"}'

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Path Parameters

id
string<uuid>
required

Body

application/json

At least one of finalData or artists is required.

finalData
object

Merged (not replaced) into the item's existing finalData. Unknown keys outside the allowlist are silently dropped.

Example:
{
"title": "Corrected Title",
"iswc": "T-034524680-1"
}
artists
object
Example:
{
"Jane Doe": "primary",
"Guest Artist": "featuring"
}

Response

Import item updated

status
string
Example:

"success"

message
string
Example:

"Import item updated"

data
object