Transition a claim's status

curl --request PATCH \
  --url https://api.royalti.io/publishing/claims/{id}/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "toStatus": "resolved",
  "reason": "Verified split documentation with both parties."
}
'

import requests

url = "https://api.royalti.io/publishing/claims/{id}/status"

payload = {
    "toStatus": "resolved",
    "reason": "Verified split documentation with both parties."
}
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({
    toStatus: 'resolved',
    reason: 'Verified split documentation with both parties.'
  })
};

fetch('https://api.royalti.io/publishing/claims/{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/publishing/claims/{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([
    'toStatus' => 'resolved',
    'reason' => 'Verified split documentation with both parties.'
  ]),
  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/publishing/claims/{id}/status"

	payload := strings.NewReader("{\n  \"toStatus\": \"resolved\",\n  \"reason\": \"Verified split documentation with both parties.\"\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/publishing/claims/{id}/status")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"toStatus\": \"resolved\",\n  \"reason\": \"Verified split documentation with both parties.\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/publishing/claims/{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  \"toStatus\": \"resolved\",\n  \"reason\": \"Verified split documentation with both parties.\"\n}"

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

{
  "status": "success",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenantId": 123,
    "workId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "claimantWriterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "claimantUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "claimedRole": "CA",
    "claimedShares": {
      "pr": 123,
      "mr": 123,
      "sr": 123
    },
    "claimType": "ownership",
    "status": "filed",
    "evidenceUrls": [
      "<string>"
    ],
    "resolution": {
      "decision": "approved",
      "reason": "<string>",
      "resolvedById": "<string>",
      "resolvedAt": "2023-11-07T05:31:56Z"
    },
    "parentClaimId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z"
  }
}

{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

PATCH

publishing

claims

{id}

status

Transition a claim's status

curl --request PATCH \
  --url https://api.royalti.io/publishing/claims/{id}/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "toStatus": "resolved",
  "reason": "Verified split documentation with both parties."
}
'

import requests

url = "https://api.royalti.io/publishing/claims/{id}/status"

payload = {
    "toStatus": "resolved",
    "reason": "Verified split documentation with both parties."
}
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({
    toStatus: 'resolved',
    reason: 'Verified split documentation with both parties.'
  })
};

fetch('https://api.royalti.io/publishing/claims/{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/publishing/claims/{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([
    'toStatus' => 'resolved',
    'reason' => 'Verified split documentation with both parties.'
  ]),
  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/publishing/claims/{id}/status"

	payload := strings.NewReader("{\n  \"toStatus\": \"resolved\",\n  \"reason\": \"Verified split documentation with both parties.\"\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/publishing/claims/{id}/status")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"toStatus\": \"resolved\",\n  \"reason\": \"Verified split documentation with both parties.\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/publishing/claims/{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  \"toStatus\": \"resolved\",\n  \"reason\": \"Verified split documentation with both parties.\"\n}"

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

{
  "status": "success",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenantId": 123,
    "workId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "claimantWriterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "claimantUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "claimedRole": "CA",
    "claimedShares": {
      "pr": 123,
      "mr": 123,
      "sr": 123
    },
    "claimType": "ownership",
    "status": "filed",
    "evidenceUrls": [
      "<string>"
    ],
    "resolution": {
      "decision": "approved",
      "reason": "<string>",
      "resolvedById": "<string>",
      "resolvedAt": "2023-11-07T05:31:56Z"
    },
    "parentClaimId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z"
  }
}

{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

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

Description

PATCH /publishing/claims//status Description: Moves a claim through the explicit state machine: filed → under_review | withdrawn, under_review → counter_claimed | resolved | escalated, counter_claimed → resolved | escalated, escalated → resolved. resolved and withdrawn are terminal. withdrawn may only be requested by the claimant themselves, and only from filed. Every other transition requires admin or owner. Records a system DisputeMessage and emits PUBLISHING_CLAIM_STATUS_CHANGED on success. Supports the Idempotency-Key header (route key p5.claim.transition) — a replay with the same key and body returns the cached response; the same key with a different body returns 409. Authorization:

RBAC: user or higher (finer-grained rules above are enforced in the service, not RBAC middleware)
Requires an active publisher addon

Method: PATCH

Code Examples

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

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

import requests

response = requests.patch(
  'https://api.royalti.io/publishing/claims/example-id/status',
  headers={
    'Authorization': f'Bearer {token}'
  },
  json={"toStatus":"sample-toStatus","reason":"sample-reason"}
)

data = response.json()
print(data)

curl -X PATCH https://api.royalti.io/publishing/claims/example-id/status \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"toStatus":"sample-toStatus","reason":"sample-reason"}'

Authorizations

Authorization

string

header

required

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

Headers

Idempotency-Key

string

Path Parameters

string<uuid>

required

Body

application/json

toStatus

enum<string>

required

Available options:

filed,

under_review,

counter_claimed,

resolved,

escalated,

withdrawn

reason

string

required

Response

Claim updated

status

string

Example:

"success"

data

object

Ownership/share/metadata dispute filed against a work. Full claim lifecycle (transition, messages, evidence, bulk-resolve) is documented separately under publishing-claims.yaml; only the two work-scoped routes (file, list-for-work) live under /work.

Show child attributes

​Description

​Code Examples

Authorizations

Headers

Path Parameters

Body

Response

Description

Code Examples