Skip to main content
POST
/
publishing
/
claims
/
{id}
/
messages
Post a comment on a claim's thread
curl --request POST \
  --url https://api.royalti.io/publishing/claims/{id}/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "body": "We've located the original split sheet — attaching it now."
}
EOF
import requests

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

payload = { "body": "We've located the original split sheet — attaching it now." }
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({
body: JSON.stringify('We\'ve located the original split sheet — attaching it now.')
})
};

fetch('https://api.royalti.io/publishing/claims/{id}/messages', 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}/messages",
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([
'body' => 'We\'ve located the original split sheet — attaching it now.'
]),
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}/messages"

payload := strings.NewReader("{\n \"body\": \"We've located the original split sheet — attaching it now.\"\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/publishing/claims/{id}/messages")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"body\": \"We've located the original split sheet — attaching it now.\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/publishing/claims/{id}/messages")

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 \"body\": \"We've located the original split sheet — attaching it now.\"\n}"

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenantId": 123,
    "claimId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "subjectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "authorUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "body": "<string>",
    "attachmentUrls": [
      "<string>"
    ],
    "parentMessageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "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

POST /publishing/claims//messages Description: Appends a comment message to the claim’s dispute thread. Only the claimant or a tenant admin/owner may post. Emits PUBLISHING_CLAIM_MESSAGE_POSTED. Supports the Idempotency-Key header (route key p5.claim.message). Authorization:
  • RBAC: user or higher; claimant-or-admin check enforced in the service
  • Requires an active publisher addon
Method: POST

Code Examples

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

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

response = requests.post(
  'https://api.royalti.io/publishing/claims/example-id/messages',
  headers={
    'Authorization': f'Bearer {token}'
  },
  json={"body":"sample-body","attachmentUrls":[{}],"parentMessageId":"sample-parentMessageId"}
)

data = response.json()
print(data)
curl -X POST https://api.royalti.io/publishing/claims/example-id/messages \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"body":"sample-body","attachmentUrls":[{}],"parentMessageId":"sample-parentMessageId"}'

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string

Path Parameters

id
string<uuid>
required

Body

application/json
body
string
required
attachmentUrls
string[]
parentMessageId
string<uuid> | null

Response

Message created

status
string
Example:

"success"

data
object