Skip to main content
PATCH
/
work
/
registrations
/
{id}
/
status
Update registration status
curl --request PATCH \
  --url https://api.royalti.io/work/registrations/{id}/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "notes": "<string>"
}
'
import requests

url = "https://api.royalti.io/work/registrations/{id}/status"

payload = { "notes": "<string>" }
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({notes: '<string>'})
};

fetch('https://api.royalti.io/work/registrations/{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/work/registrations/{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([
'notes' => '<string>'
]),
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/work/registrations/{id}/status"

payload := strings.NewReader("{\n \"notes\": \"<string>\"\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/work/registrations/{id}/status")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"notes\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/work/registrations/{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 \"notes\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenantId": 123,
    "societyCode": "<string>",
    "societyName": "<string>",
    "registrationStatus": "pending",
    "statusDate": "2023-11-07T05:31:56Z",
    "confirmationNumber": "<string>",
    "registrationId": "<string>",
    "notes": "<string>",
    "metadata": {},
    "queuedAt": "2023-11-07T05:31:56Z",
    "submittedAt": "2023-11-07T05:31:56Z",
    "submissionFileId": "<string>",
    "submissionFileHash": "<string>",
    "attempts": 0,
    "lastAttemptAt": "2023-11-07T05:31:56Z",
    "lastErrorMessage": "<string>",
    "isDeadLettered": true,
    "work": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "workTitle": "<string>",
      "iswc": "<string>",
      "submitterWorkNumber": "<string>"
    }
  }
}
{
"status": "error",
"message": "<string>",
"code": "<string>",
"details": {}
}
{
"status": "error",
"message": "<string>",
"code": "<string>",
"details": {}
}
{
"status": "error",
"message": "<string>",
"code": "<string>",
"details": {}
}
{
"status": "error",
"message": "<string>",
"code": "<string>",
"details": {}
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

PATCH /work/registrations//status Description: Direct status override (e.g. manually marking a registration registered after confirming with a society out-of-band). Sets statusDate to now and stamps metadata.updatedBy/lastUpdated. Unlike queueForPro, this has NO “must currently be pending” restriction — any status can transition to any other status here. Authorization:
  • Required role: admin or higher
Method: PATCH

Code Examples

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

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

response = requests.patch(
  'https://api.royalti.io/work/registrations/{id}/status',
  headers={
    'Authorization': f'Bearer {token}'
  },
  json={"status":"sample-status","notes":"sample-notes"}
)

data = response.json()
print(data)
curl -X PATCH https://api.royalti.io/work/registrations/{id}/status \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"status":"sample-status","notes":"sample-notes"}'

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:
pending,
submitted,
registered,
rejected,
conflict,
cancelled
notes
string

Response

Status updated

success
boolean
Example:

true

data
object