Skip to main content
PATCH
/
publisher-writer
/
agreements
/
{id}
/
status
Update an agreement's status
curl --request PATCH \
  --url https://api.royalti.io/publisher-writer/agreements/{id}/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "active"
}
'
import requests

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

payload = { "status": "active" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({status: 'active'})
};

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

	payload := strings.NewReader("{\n  \"status\": \"active\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.royalti.io/publisher-writer/agreements/{id}/status")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"status\": \"active\"\n}")
  .asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"status\": \"active\"\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

PATCH /publisher-writer/agreements//status Description: Sets status on the agreement. status must be one of the AgreementStatus enum values or the request is rejected with 400 before any transaction is opened. Does not otherwise validate a state-machine transition (e.g. terminated → active is allowed). Authorization:
  • Required role: admin or higher
Method: PATCH

​
Code Examples

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

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

import requests

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

data = response.json()
print(data)

curl -X PATCH https://api.royalti.io/publisher-writer/agreements/example-id/status \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<uuid>
required

Body

application/json
​
status
enum<string>
required
Available options:
draft,
pending,
active,
expired,
terminated

Response

Status updated

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