Skip to main content
POST
/
publisher
/
sub-publishing
Create a sub-publishing agreement
curl --request POST \
  --url https://api.royalti.io/publisher/sub-publishing \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "originalPublisherId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "subPublisherId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agreementNumber": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "terms": {
    "territories": [
      "<string>"
    ],
    "rightTypes": [],
    "shares": {
      "pr": 123,
      "mr": 123,
      "sr": 123
    },
    "exclusivity": true,
    "restrictions": [
      "<string>"
    ]
  },
  "endDate": "2023-11-07T05:31:56Z"
}
'
import requests

url = "https://api.royalti.io/publisher/sub-publishing"

payload = {
    "originalPublisherId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "subPublisherId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "agreementNumber": "<string>",
    "startDate": "2023-11-07T05:31:56Z",
    "terms": {
        "territories": ["<string>"],
        "rightTypes": [],
        "shares": {
            "pr": 123,
            "mr": 123,
            "sr": 123
        },
        "exclusivity": True,
        "restrictions": ["<string>"]
    },
    "endDate": "2023-11-07T05:31:56Z"
}
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({
    originalPublisherId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    subPublisherId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    agreementNumber: '<string>',
    startDate: '2023-11-07T05:31:56Z',
    terms: {
      territories: ['<string>'],
      rightTypes: [],
      shares: {pr: 123, mr: 123, sr: 123},
      exclusivity: true,
      restrictions: ['<string>']
    },
    endDate: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.royalti.io/publisher/sub-publishing', 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/sub-publishing",
  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([
    'originalPublisherId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'subPublisherId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'agreementNumber' => '<string>',
    'startDate' => '2023-11-07T05:31:56Z',
    'terms' => [
        'territories' => [
                '<string>'
        ],
        'rightTypes' => [
                
        ],
        'shares' => [
                'pr' => 123,
                'mr' => 123,
                'sr' => 123
        ],
        'exclusivity' => true,
        'restrictions' => [
                '<string>'
        ]
    ],
    'endDate' => '2023-11-07T05:31:56Z'
  ]),
  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/sub-publishing"

	payload := strings.NewReader("{\n  \"originalPublisherId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"subPublisherId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"agreementNumber\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"terms\": {\n    \"territories\": [\n      \"<string>\"\n    ],\n    \"rightTypes\": [],\n    \"shares\": {\n      \"pr\": 123,\n      \"mr\": 123,\n      \"sr\": 123\n    },\n    \"exclusivity\": true,\n    \"restrictions\": [\n      \"<string>\"\n    ]\n  },\n  \"endDate\": \"2023-11-07T05:31:56Z\"\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/sub-publishing")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"originalPublisherId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"subPublisherId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"agreementNumber\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"terms\": {\n    \"territories\": [\n      \"<string>\"\n    ],\n    \"rightTypes\": [],\n    \"shares\": {\n      \"pr\": 123,\n      \"mr\": 123,\n      \"sr\": 123\n    },\n    \"exclusivity\": true,\n    \"restrictions\": [\n      \"<string>\"\n    ]\n  },\n  \"endDate\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/publisher/sub-publishing")

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  \"originalPublisherId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"subPublisherId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"agreementNumber\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"terms\": {\n    \"territories\": [\n      \"<string>\"\n    ],\n    \"rightTypes\": [],\n    \"shares\": {\n      \"pr\": 123,\n      \"mr\": 123,\n      \"sr\": 123\n    },\n    \"exclusivity\": true,\n    \"restrictions\": [\n      \"<string>\"\n    ]\n  },\n  \"endDate\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body
{
  "message": "<string>",
  "agreement": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "originalPublisherId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "subPublisherId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenantId": 123,
    "agreementNumber": "<string>",
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "terms": {
      "rightTypes": [],
      "shares": {},
      "retentionRate": 50,
      "territories": [
        "<string>"
      ],
      "exclusivity": true,
      "restrictions": [
        "<string>"
      ],
      "minimumGuarantee": {
        "amount": 123,
        "currency": "<string>"
      },
      "recoupmentTerms": {
        "recoupable": true,
        "recoupmentRate": 123,
        "crossCollateralization": true
      }
    },
    "originalPublisher": {},
    "subPublisher": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}
{
  "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/sub-publishing Validates that both publishers exist in the tenant, checks territory conflicts against the sub-publisher’s existing coverage, and (on success) creates matching PublisherTerritory rows for the sub-publisher for each territory in terms.territories. Authorization: admin role + publisher addon.

​
Code Examples

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

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

import requests

response = requests.post(
  'https://api.royalti.io/publisher/sub-publishing',
  headers={
    'Authorization': f'Bearer {token}'
  },
  json={"ref":"#/components/schemas/CreateSubPublishingAgreementRequest"}
)

data = response.json()
print(data)

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

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
originalPublisherId
string<uuid>
required
​
subPublisherId
string<uuid>
required
​
agreementNumber
string
required
​
startDate
string<date-time>
required
​
terms
object
required
​
endDate
string<date-time> | null

Response

Agreement created.

​
message
string
​
agreement
object