Skip to main content
DELETE
/
publisher-writer
/
agreements
/
{id}
/
territories
/
{territoryCode}
Remove a territory from an agreement
curl --request DELETE \
  --url https://api.royalti.io/publisher-writer/agreements/{id}/territories/{territoryCode} \
  --header 'Authorization: Bearer <token>'
import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.delete(url, headers=headers)

print(response.text)
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.royalti.io/publisher-writer/agreements/{id}/territories/{territoryCode}', 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/{territoryCode}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("DELETE", url, nil)

	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.delete("https://api.royalti.io/publisher-writer/agreements/{id}/territories/{territoryCode}")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

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

DELETE /publisher-writer/agreements//territories/ Description: Removes the entry matching territoryCode from the agreement’s territories array inside a DB transaction. 404s if no territory with that code exists on the agreement. Authorization:
  • Required role: admin or higher
Method: DELETE

​
Code Examples

const response = await fetch('https://api.royalti.io/publisher-writer/agreements/example-id/territories/US', {
  method: 'DELETE',
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

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

import requests

response = requests.delete(
  'https://api.royalti.io/publisher-writer/agreements/example-id/territories/US',
  headers={
    'Authorization': f'Bearer {token}'
  },
)

data = response.json()
print(data)

curl -X DELETE https://api.royalti.io/publisher-writer/agreements/example-id/territories/US \
  -H "Authorization: Bearer YOUR_TOKEN" \

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<uuid>
required
​
territoryCode
string
required

Response

Territory removed; full updated agreement returned

​
id
string<uuid>
​
tenantId
integer
​
publisherId
string<uuid>
​
writerId
string<uuid>
​
name
string
​
description
string | null
​
territories
object[]
​
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).

​
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).

​
createdAt
string<date-time>
​
updatedAt
string<date-time>