Update a publisher-writer agreement

curl --request PUT \
  --url https://api.royalti.io/publisher-writer/agreements/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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
}
'

import requests

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

payload = {
    "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
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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
  })
};

fetch('https://api.royalti.io/publisher-writer/agreements/{id}', 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}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    '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
  ]),
  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}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"territories\": [\n    {\n      \"territoryCode\": \"WW\",\n      \"prShare\": 50,\n      \"mrShare\": 50,\n      \"srShare\": 50,\n      \"startDate\": \"2023-11-07T05:31:56Z\",\n      \"endDate\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"contractNumber\": \"<string>\",\n  \"contractDate\": \"2023-11-07T05:31:56Z\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"isActive\": true\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.royalti.io/publisher-writer/agreements/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"territories\": [\n    {\n      \"territoryCode\": \"WW\",\n      \"prShare\": 50,\n      \"mrShare\": 50,\n      \"srShare\": 50,\n      \"startDate\": \"2023-11-07T05:31:56Z\",\n      \"endDate\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"contractNumber\": \"<string>\",\n  \"contractDate\": \"2023-11-07T05:31:56Z\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"isActive\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"territories\": [\n    {\n      \"territoryCode\": \"WW\",\n      \"prShare\": 50,\n      \"mrShare\": 50,\n      \"srShare\": 50,\n      \"startDate\": \"2023-11-07T05:31:56Z\",\n      \"endDate\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"contractNumber\": \"<string>\",\n  \"contractDate\": \"2023-11-07T05:31:56Z\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"isActive\": true\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",
      "inclusionExclusion": "I",
      "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",
  "status": "draft",
  "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>"
}

PUT

publisher-writer

agreements

{id}

Update a publisher-writer agreement

curl --request PUT \
  --url https://api.royalti.io/publisher-writer/agreements/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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
}
'

import requests

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

payload = {
    "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
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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
  })
};

fetch('https://api.royalti.io/publisher-writer/agreements/{id}', 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}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    '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
  ]),
  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}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"territories\": [\n    {\n      \"territoryCode\": \"WW\",\n      \"prShare\": 50,\n      \"mrShare\": 50,\n      \"srShare\": 50,\n      \"startDate\": \"2023-11-07T05:31:56Z\",\n      \"endDate\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"contractNumber\": \"<string>\",\n  \"contractDate\": \"2023-11-07T05:31:56Z\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"isActive\": true\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.royalti.io/publisher-writer/agreements/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"territories\": [\n    {\n      \"territoryCode\": \"WW\",\n      \"prShare\": 50,\n      \"mrShare\": 50,\n      \"srShare\": 50,\n      \"startDate\": \"2023-11-07T05:31:56Z\",\n      \"endDate\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"contractNumber\": \"<string>\",\n  \"contractDate\": \"2023-11-07T05:31:56Z\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"isActive\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"territories\": [\n    {\n      \"territoryCode\": \"WW\",\n      \"prShare\": 50,\n      \"mrShare\": 50,\n      \"srShare\": 50,\n      \"startDate\": \"2023-11-07T05:31:56Z\",\n      \"endDate\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"contractNumber\": \"<string>\",\n  \"contractDate\": \"2023-11-07T05:31:56Z\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"isActive\": true\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",
      "inclusionExclusion": "I",
      "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",
  "status": "draft",
  "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

PUT /publisher-writer/agreements/ Description: Partial update inside a DB transaction. If territories is supplied, it is validated and checked for conflicts against the publisher/writer pair’s OTHER active agreements (excluding this one) — a conflict rolls back and returns 400. publisherId/ writerId are not reassignable through this endpoint (they are not read from the body by the service layer’s update path). Authorization:

Required role: admin or higher

Method: PUT

Code Examples

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

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

import requests

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

data = response.json()
print(data)

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

Authorizations

Authorization

string

header

required

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

Path Parameters

string<uuid>

required

Body

application/json

Partial update — any subset of AgreementCreateRequest's fields (excluding publisherId/writerId, which are immutable via this endpoint).

name

string

description

string

territories

object[]

Show child attributes

contractNumber

string

contractDate

string<date-time>

startDate

string<date-time>

endDate

string<date-time>

status

enum<string>

Available options:

draft,

pending,

active,

expired,

terminated

isActive

boolean

Response

Agreement updated

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>

​Description

​Code Examples

Authorizations

Path Parameters

Body

Response

Description

Code Examples