Add a territory to an agreement

curl --request POST \
  --url https://api.royalti.io/publisher-writer/agreements/{id}/territories \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "territoryCode": "US",
  "inclusionExclusion": "I",
  "prShare": 100,
  "mrShare": 100,
  "srShare": 100
}
'

import requests

url = "https://api.royalti.io/publisher-writer/agreements/{id}/territories"

payload = {
    "territoryCode": "US",
    "inclusionExclusion": "I",
    "prShare": 100,
    "mrShare": 100,
    "srShare": 100
}
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: 'US',
    inclusionExclusion: 'I',
    prShare: 100,
    mrShare: 100,
    srShare: 100
  })
};

fetch('https://api.royalti.io/publisher-writer/agreements/{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-writer/agreements/{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' => 'US',
    'inclusionExclusion' => 'I',
    'prShare' => 100,
    'mrShare' => 100,
    'srShare' => 100
  ]),
  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-writer/agreements/{id}/territories"

	payload := strings.NewReader("{\n  \"territoryCode\": \"US\",\n  \"inclusionExclusion\": \"I\",\n  \"prShare\": 100,\n  \"mrShare\": 100,\n  \"srShare\": 100\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-writer/agreements/{id}/territories")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"territoryCode\": \"US\",\n  \"inclusionExclusion\": \"I\",\n  \"prShare\": 100,\n  \"mrShare\": 100,\n  \"srShare\": 100\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/publisher-writer/agreements/{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\": \"US\",\n  \"inclusionExclusion\": \"I\",\n  \"prShare\": 100,\n  \"mrShare\": 100,\n  \"srShare\": 100\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenantId": 123,
  "publisherId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "writerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "territories": [
    {
      "territoryCode": "WW",
      "prShare": 50,
      "mrShare": 50,
      "srShare": 50,
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z"
    }
  ],
  "contractNumber": "<string>",
  "contractDate": "2023-11-07T05:31:56Z",
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "isActive": true,
  "publisher": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "writer": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "message": "<string>",
  "error": "<string>"
}

{
  "message": "<string>",
  "error": "<string>"
}

{
  "message": "<string>",
  "error": "<string>"
}

POST

publisher-writer

agreements

{id}

territories

Add a territory to an agreement

curl --request POST \
  --url https://api.royalti.io/publisher-writer/agreements/{id}/territories \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "territoryCode": "US",
  "inclusionExclusion": "I",
  "prShare": 100,
  "mrShare": 100,
  "srShare": 100
}
'

import requests

url = "https://api.royalti.io/publisher-writer/agreements/{id}/territories"

payload = {
    "territoryCode": "US",
    "inclusionExclusion": "I",
    "prShare": 100,
    "mrShare": 100,
    "srShare": 100
}
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: 'US',
    inclusionExclusion: 'I',
    prShare: 100,
    mrShare: 100,
    srShare: 100
  })
};

fetch('https://api.royalti.io/publisher-writer/agreements/{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-writer/agreements/{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' => 'US',
    'inclusionExclusion' => 'I',
    'prShare' => 100,
    'mrShare' => 100,
    'srShare' => 100
  ]),
  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-writer/agreements/{id}/territories"

	payload := strings.NewReader("{\n  \"territoryCode\": \"US\",\n  \"inclusionExclusion\": \"I\",\n  \"prShare\": 100,\n  \"mrShare\": 100,\n  \"srShare\": 100\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-writer/agreements/{id}/territories")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"territoryCode\": \"US\",\n  \"inclusionExclusion\": \"I\",\n  \"prShare\": 100,\n  \"mrShare\": 100,\n  \"srShare\": 100\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/publisher-writer/agreements/{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\": \"US\",\n  \"inclusionExclusion\": \"I\",\n  \"prShare\": 100,\n  \"mrShare\": 100,\n  \"srShare\": 100\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenantId": 123,
  "publisherId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "writerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "territories": [
    {
      "territoryCode": "WW",
      "prShare": 50,
      "mrShare": 50,
      "srShare": 50,
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z"
    }
  ],
  "contractNumber": "<string>",
  "contractDate": "2023-11-07T05:31:56Z",
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "isActive": true,
  "publisher": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "writer": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "message": "<string>",
  "error": "<string>"
}

{
  "message": "<string>",
  "error": "<string>"
}

{
  "message": "<string>",
  "error": "<string>"
}

This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

POST /publisher-writer/agreements//territories Description: Appends a single territory to the agreement’s territories array inside a DB transaction. Rejects (400) if territoryCode is missing, if a territory with the same territoryCode already exists on this agreement, or if the new territory conflicts with one on any of this publisher/writer pair’s OTHER active agreements. Authorization:

Required role: admin or higher

Method: POST

Code Examples

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

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

import requests

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

data = response.json()
print(data)

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

Authorizations

Authorization

string

header

required

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

Path Parameters

string<uuid>

required

Body

application/json

territoryCode

string

required

CISAC TIS territory code, or a formula (e.g. "2136 BUT NOT 2250"). WW = worldwide.

Example:

"WW"

inclusionExclusion

enum<string>

required

Available options:

I,

E

Required range: 0 <= x <= 100

startDate

string<date-time>

endDate

string<date-time> | null

Response

Territory added; full updated agreement returned

string<uuid>

tenantId

integer

publisherId

string<uuid>

writerId

string<uuid>

name

string

description

string | null

territories

object[]

Show child attributes

contractNumber

string | null

contractDate

string<date-time> | null

startDate

string<date-time> | null

endDate

string<date-time> | null

status

enum<string>

Available options:

draft,

pending,

active,

expired,

terminated

isActive

boolean

default:true

publisher

object

Only present when the record was loaded via the model's default scope (all reads; NOT present on the POST /agreements create response).

Show child attributes

writer

object

Only present when the record was loaded via the model's default scope (all reads; NOT present on the POST /agreements create response).

Show child attributes

createdAt

string<date-time>

updatedAt

string<date-time>

Update an agreement's status

Remove a territory from an agreement

​Description

​Code Examples

Authorizations

Path Parameters

Body

Response

Description

Code Examples