Skip to main content
POST
/
publisher
/
publishers
/
export
/
cwr
Export a CWR registration file for one publisher
curl --request POST \
  --url https://api.royalti.io/publisher/publishers/export/cwr \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "publisherIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "version": "2.1"
}
'
import requests

url = "https://api.royalti.io/publisher/publishers/export/cwr"

payload = {
    "publisherIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "version": "2.1"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({publisherIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'], version: '2.1'})
};

fetch('https://api.royalti.io/publisher/publishers/export/cwr', 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/publisher/publishers/export/cwr",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'publisherIds' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'version' => '2.1'
  ]),
  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/publisher/publishers/export/cwr"

	payload := strings.NewReader("{\n  \"publisherIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"version\": \"2.1\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.royalti.io/publisher/publishers/export/cwr")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"publisherIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"version\": \"2.1\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/publisher/publishers/export/cwr")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"publisherIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"version\": \"2.1\"\n}"

response = http.request(request)
puts response.read_body
"<string>"
{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}
{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

POST /publisher/publishers/export/cwr Generates a CWR file (text/plain) for the tenant’s exportable works (works missing required fields are excluded — see the X-CWR-Excluded-Count response header) using the given publisher’s territories and agreement block. Exactly one publisherIds entry is accepted per call; a CWR file carries a single sender/publisher chain, so multi-publisher requests are rejected rather than silently dropping publishers. Authorization: admin role + publisher addon.

​
Code Examples

const response = await fetch('https://api.royalti.io/publisher/publishers/export/cwr', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "ref": "#/components/schemas/CWRExportRequest"
  })
});

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

import requests

response = requests.post(
  'https://api.royalti.io/publisher/publishers/export/cwr',
  headers={
    'Authorization': f'Bearer {token}'
  },
  json={"ref":"#/components/schemas/CWRExportRequest"}
)

data = response.json()
print(data)

curl -X POST https://api.royalti.io/publisher/publishers/export/cwr \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ref":"#/components/schemas/CWRExportRequest"}'

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
publisherIds
string<uuid>[]
required

Exactly one publisher id — a CWR file carries a single sender/publisher chain. Requests with more than one id return 400.

Required array length: 1 element
​
version
string
default:2.1
Example:

"2.1"

Response

CWR file generated.

The response is of type file.