Skip to main content
PUT
/
asset
/
{id}
/
ddex-metadata
Update Asset DDEX Metadata
curl --request PUT \
  --url https://api.royalti.io/asset/{id}/ddex-metadata \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ddexMetadata": {
    "releaseType": "Single",
    "recordLabel": "Example Records"
  },
  "resourceReference": "A123456789",
  "technicalResourceDetails": {
    "fileFormat": "WAV",
    "audioCodec": "PCM",
    "bitrate": 1411,
    "sampleRate": 44100,
    "duration": "PT3M45S"
  }
}
'
{
  "status": "success",
  "message": "DDEX metadata updated successfully",
  "data": {
    "id": "<string>",
    "ddexMetadata": {},
    "resourceReference": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

PUT /asset//ddex-metadata Description: Update DDEX-specific metadata for an asset. This endpoint allows you to add or modify metadata fields required for DDEX delivery, including resource references, technical details, sound recording information, and musical work references. Method: PUT Path Parameter:
ParameterTypeDescription
idstringThe unique identifier of the asset
Request Payload:
ParameterTypeDescription
ddexMetadataobjectDDEX metadata object
resourceReferencestringResource reference identifier
technicalResourceDetailsobjectTechnical details of the resource
soundRecordingDetailsobjectSound recording specific details
musicalWorkReferenceobjectMusical work reference information
Use Cases:
  • Prepare asset for DDEX delivery
  • Update technical specifications
  • Add sound recording details
  • Link to musical work references

​
Code Examples

const response = await fetch('https://api.royalti.io/asset/example-id/ddex-metadata', {
  method: 'PUT',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "ddexMetadata": {},
    "resourceReference": "A123456789",
    "technicalResourceDetails": {
      "fileFormat": "WAV",
      "audioCodec": "PCM",
      "bitrate": 1411,
      "sampleRate": 44100,
      "duration": "PT3M45S"
    },
    "soundRecordingDetails": {
      "recordingDate": "2024-01-15",
      "recordingLocation": "Abbey Road Studios",
      "language": "en"
    },
    "musicalWorkReference": {
      "workId": "work-123",
      "iswc": "T-123456789-0"
    }
  })
});

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

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Asset ID

Body

application/json
​
ddexMetadata
object

DDEX metadata object

​
resourceReference
string

Resource reference identifier

Example:

"A123456789"

​
technicalResourceDetails
object

Technical details of the resource

​
soundRecordingDetails
object

Sound recording specific details

​
musicalWorkReference
object

Musical work reference information

Response

DDEX metadata updated successfully

​
status
string
Example:

"success"

​
message
string
Example:

"DDEX metadata updated successfully"

​
data
object