Skip to main content
POST
/
publisher
/
publishers
/
{id}
/
territories
Add a territory to a publisher
curl --request POST \
  --url https://api.royalti.io/publisher/publishers/{id}/territories \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "territoryCode": "<string>",
  "prShare": 50,
  "mrShare": 50,
  "srShare": 50,
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z"
}
'
import requests

url = "https://api.royalti.io/publisher/publishers/{id}/territories"

payload = {
    "territoryCode": "<string>",
    "prShare": 50,
    "mrShare": 50,
    "srShare": 50,
    "startDate": "2023-11-07T05:31:56Z",
    "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({
    territoryCode: '<string>',
    prShare: 50,
    mrShare: 50,
    srShare: 50,
    startDate: '2023-11-07T05:31:56Z',
    endDate: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.royalti.io/publisher/publishers/{id}/territories', 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/{id}/territories",
  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([
    'territoryCode' => '<string>',
    'prShare' => 50,
    'mrShare' => 50,
    'srShare' => 50,
    'startDate' => '2023-11-07T05:31:56Z',
    '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/publishers/{id}/territories"

	payload := strings.NewReader("{\n  \"territoryCode\": \"<string>\",\n  \"prShare\": 50,\n  \"mrShare\": 50,\n  \"srShare\": 50,\n  \"startDate\": \"2023-11-07T05:31:56Z\",\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/publishers/{id}/territories")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"territoryCode\": \"<string>\",\n  \"prShare\": 50,\n  \"mrShare\": 50,\n  \"srShare\": 50,\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/publisher/publishers/{id}/territories")

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  \"territoryCode\": \"<string>\",\n  \"prShare\": 50,\n  \"mrShare\": 50,\n  \"srShare\": 50,\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "TenantId": 123,
  "publisherId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "territoryCode": "US",
  "inclusionExclusion": "I",
  "prShare": 50,
  "mrShare": 50,
  "srShare": 50,
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "rights": [
    {
      "share": 123
    }
  ],
  "formula": "<string>",
  "postTermCollection": false,
  "agreementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "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

Validates territory-basics, PR/MR/SR share totals, and checks for overlapping territory coverage on the publisher before and after creation.

​
Code Examples

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

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

import requests

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

data = response.json()
print(data)

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

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<uuid>
required

Body

application/json
​
territoryCode
string
required
​
prShare
number
required
Required range: 0 <= x <= 100
​
mrShare
number
required
Required range: 0 <= x <= 100
​
srShare
number
required
Required range: 0 <= x <= 100
​
startDate
string<date-time>
required
​
inclusionExclusion
enum<string>
Available options:
I,
E
​
endDate
string<date-time> | null

Response

Territory created.

​
id
string<uuid>
​
TenantId
integer
​
publisherId
string<uuid>
​
territoryCode
string

ISO territory code or 'WW' for worldwide.

Example:

"US"

​
inclusionExclusion
enum<string>
default:I
Available options:
I,
E
​
prShare
number
Required range: 0 <= x <= 100
​
mrShare
number
Required range: 0 <= x <= 100
​
srShare
number
Required range: 0 <= x <= 100
​
startDate
string<date-time>
​
endDate
string<date-time> | null
​
rights
object[]
​
formula
string | null

CWR 2.2+ territory formula, e.g. "2136 BUT NOT 2250". At most one exclusion marker (EX/X).

​
postTermCollection
boolean
default:false
​
assignmentType
enum<string> | null
Available options:
DIRECT,
SUB,
ADMIN
​
licenseType
enum<string> | null
Available options:
EXCLUSIVE,
NON-EXCLUSIVE
​
agreementId
string<uuid> | null
​
createdAt
string<date-time>
​
updatedAt
string<date-time>