Skip to main content
POST
/
source-creator
/
save
Step 5 — Save as a draft RoyaltySource
curl --request POST \
  --url https://api.royalti.io/source-creator/save \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "feeRate": 123,
  "feeType": "percentage",
  "feeDescription": "<string>"
}
'
import requests

url = "https://api.royalti.io/source-creator/save"

payload = {
    "sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "feeRate": 123,
    "feeType": "percentage",
    "feeDescription": "<string>"
}
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({
    sessionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    feeRate: 123,
    feeType: 'percentage',
    feeDescription: '<string>'
  })
};

fetch('https://api.royalti.io/source-creator/save', 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/source-creator/save",
  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([
    'sessionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'feeRate' => 123,
    'feeType' => 'percentage',
    'feeDescription' => '<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/source-creator/save"

	payload := strings.NewReader("{\n  \"sessionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"feeRate\": 123,\n  \"feeType\": \"percentage\",\n  \"feeDescription\": \"<string>\"\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/source-creator/save")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"sessionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"feeRate\": 123,\n  \"feeType\": \"percentage\",\n  \"feeDescription\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/source-creator/save")

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  \"sessionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"feeRate\": 123,\n  \"feeType\": \"percentage\",\n  \"feeDescription\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "message": "Draft source created successfully",
  "data": {
    "royaltySourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenantRoyaltySourceId": 123,
    "sourceName": "<string>",
    "sourceLabel": "<string>"
  }
}
{
  "status": "error",
  "message": "<string>"
}
{
  "status": "error",
  "message": "This feature requires a plan upgrade",
  "data": {
    "feature": "royaltyAccess",
    "currentPlan": "FREE",
    "availablePlans": [
      {}
    ]
  }
}
{
  "status": "error",
  "message": "<string>"
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

POST /source-creator/save Description: Persists the session as a new RoyaltySource (created private, public: false, type: 'user_created') plus a TenantDataSource link and SourceColumnMapping rows. Derives a typed BigQuery schema from the sample data, populates multi-class taxonomy fields (dataClass, grain, economicRole, encoding, periodParser) from what the session captured, and — for “copy & modify” sessions — versions the table name and copies fee/period config from the parent source. Triggers a v_sales_data rebuild after the transaction commits. Requires session status generating or testing (i.e. queries generated; the test step is optional). Rate limited via heavyOperationLimiter (creates DB records + triggers a BigQuery rebuild). Authorization:
  • Required role: admin or higher
Method: POST

​
Code Examples

const response = await fetch('https://api.royalti.io/source-creator/save', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "ref": "#/components/schemas/SaveDraftSourceRequest"
  })
});

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

import requests

response = requests.post(
  'https://api.royalti.io/source-creator/save',
  headers={
    'Authorization': f'Bearer {token}'
  },
  json={"ref":"#/components/schemas/SaveDraftSourceRequest"}
)

data = response.json()
print(data)

curl -X POST https://api.royalti.io/source-creator/save \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ref":"#/components/schemas/SaveDraftSourceRequest"}'

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
sessionId
string<uuid>
required
​
feeRate
number | null

Fee rate as a decimal (e.g. 0.015 = 1.5%). Only applied when > 0.

​
feeType
enum<string>
default:percentage
Available options:
percentage,
fixed
​
feeDescription
string | null

Response

Draft source created successfully

​
status
string
Example:

"success"

​
message
string
Example:

"Draft source created successfully"

​
data
object