Update a PRO credential set

curl --request PATCH \
  --url https://api.royalti.io/pro-credentials/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "isActive": false
}
'

import requests

url = "https://api.royalti.io/pro-credentials/{id}"

payload = { "isActive": False }
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({isActive: false})
};

fetch('https://api.royalti.io/pro-credentials/{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/pro-credentials/{id}",
  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([
    'isActive' => false
  ]),
  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/pro-credentials/{id}"

	payload := strings.NewReader("{\n  \"isActive\": false\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/pro-credentials/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"isActive\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/pro-credentials/{id}")

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  \"isActive\": false\n}"

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

{
  "status": "success",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "TenantId": 123,
    "societyCode": "BMI",
    "societyName": "<string>",
    "accountId": "<string>",
    "submissionMethod": "SFTP",
    "encryptionVersion": 123,
    "endpointConfig": {},
    "isActive": true,
    "lastUsedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

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

PATCH

pro-credentials

{id}

Update a PRO credential set

curl --request PATCH \
  --url https://api.royalti.io/pro-credentials/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "isActive": false
}
'

import requests

url = "https://api.royalti.io/pro-credentials/{id}"

payload = { "isActive": False }
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({isActive: false})
};

fetch('https://api.royalti.io/pro-credentials/{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/pro-credentials/{id}",
  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([
    'isActive' => false
  ]),
  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/pro-credentials/{id}"

	payload := strings.NewReader("{\n  \"isActive\": false\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/pro-credentials/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"isActive\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/pro-credentials/{id}")

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  \"isActive\": false\n}"

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

{
  "status": "success",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "TenantId": 123,
    "societyCode": "BMI",
    "societyName": "<string>",
    "accountId": "<string>",
    "submissionMethod": "SFTP",
    "encryptionVersion": 123,
    "endpointConfig": {},
    "isActive": true,
    "lastUsedAt": "2023-11-07T05:31:56Z",
    "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

PATCH /pro-credentials/ Description: Partial update. Any field omitted is left unchanged. If credentials is provided it fully replaces the stored (decrypted, then re-encrypted) payload — it is not merged with the existing credential fields. submissionMethod defaults to the existing value when building the new credentials object. Authorization:

Required role: admin or higher
Requires an active publisher addon

Method: PATCH

Code Examples

const response = await fetch('https://api.royalti.io/pro-credentials/example-id', {
  method: 'PATCH',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "societyName": "sample-societyName",
    "accountId": "sample-accountId",
    "submissionMethod": "sample-submissionMethod",
    "endpointConfig": {},
    "isActive": true
  })
});

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

import requests

response = requests.patch(
  'https://api.royalti.io/pro-credentials/example-id',
  headers={
    'Authorization': f'Bearer {token}'
  },
  json={"societyName":"sample-societyName","accountId":"sample-accountId","submissionMethod":"sample-submissionMethod","endpointConfig":{},"isActive":true}
)

data = response.json()
print(data)

curl -X PATCH https://api.royalti.io/pro-credentials/example-id \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"societyName":"sample-societyName","accountId":"sample-accountId","submissionMethod":"sample-submissionMethod","endpointConfig":{},"isActive":true}'

Authorizations

Authorization

string

header

required

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

Path Parameters

string<uuid>

required

Body

application/json

societyName

string | null

accountId

string

submissionMethod

enum<string>

Available options:

SFTP,

API,

EMAIL

credentials

object

Write-only credential payload. Fields used depend on submissionMethod; unused fields are ignored.

Show child attributes

Example:

{
  "host": "sftp.example-pro.org",
  "port": 22,
  "username": "royalti-tenant-19",
  "password": "••••••••"
}

endpointConfig

object

isActive

boolean

Response

Credential set updated

status

string

Example:

"success"

data

object

Serialized row — never includes the credential payload (see the tag description).

Show child attributes

​Description

​Code Examples

Authorizations

Path Parameters

Body

Response

Description

Code Examples