Skip to main content
POST
/
dmp
/
import
/
execute
Execute a DMP import
curl --request POST \
  --url https://api.royalti.io/dmp/import/execute \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form worksFile='@example-file' \
  --form acknowledgementsFile='@example-file'
import requests

url = "https://api.royalti.io/dmp/import/execute"

files = {
    "worksFile": ("example-file", open("example-file", "rb")),
    "acknowledgementsFile": ("example-file", open("example-file", "rb"))
}
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, files=files, headers=headers)

print(response.text)
const form = new FormData();
form.append('worksFile', '<string>');
form.append('acknowledgementsFile', '<string>');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://api.royalti.io/dmp/import/execute', 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/dmp/import/execute",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"worksFile\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"acknowledgementsFile\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$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/dmp/import/execute"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"worksFile\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"acknowledgementsFile\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.royalti.io/dmp/import/execute")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"worksFile\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"acknowledgementsFile\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/dmp/import/execute")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"worksFile\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"acknowledgementsFile\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body
{
  "message": "DMP import completed successfully",
  "result": {
    "writers": {
      "created": 123,
      "existing": 123,
      "errors": [
        {}
      ]
    },
    "works": {
      "created": 123,
      "existing": 123,
      "errors": [
        {}
      ]
    },
    "workWriters": {
      "created": 123,
      "errors": [
        {}
      ]
    },
    "artists": {
      "created": 123,
      "existing": 123,
      "errors": [
        {}
      ]
    },
    "recordings": {
      "created": 123,
      "existing": 123,
      "errors": [
        {}
      ]
    },
    "workRecordings": {
      "created": 123,
      "errors": [
        {}
      ]
    },
    "crossReferences": {
      "created": 123,
      "updated": 123,
      "errors": [
        {}
      ]
    },
    "acknowledgements": {
      "created": 123,
      "updated": 123,
      "errors": [
        {}
      ]
    }
  }
}
{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

POST /dmp/import/execute Description: Same file inputs as /dmp/import/preview, but actually creates entities inside a single database transaction, run phase by phase: writers → works → work-writer relationships → artists → recordings (creates Assets + WorkRecordings) → cross-references (creates WorkRegistrations) → acknowledgements. The transaction commits even when individual records error — per-record failures are collected in each phase’s errors[], not thrown — so check result.*.errors rather than relying on a 200 status alone. A 200 with a non-zero error count still returns message describing the error count and what was created. Authorization:
  • Required role: admin or higher
Method: POST

Code Examples

const response = await fetch('https://api.royalti.io/dmp/import/execute', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
});

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

response = requests.post(
  'https://api.royalti.io/dmp/import/execute',
  headers={
    'Authorization': f'Bearer {token}'
  },
  json={}
)

data = response.json()
print(data)
curl -X POST https://api.royalti.io/dmp/import/execute \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Authorizations

Authorization
string
header
required

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

Body

multipart/form-data
worksFile
file
required

DMP works JSON export: { "works": [...] }.

acknowledgementsFile
file

Optional DMP acknowledgements CSV export.

Response

Import run completed (see result.*.errors for any per-record failures — the transaction still commits)

message
string
Example:

"DMP import completed successfully"

result
object