Skip to main content
POST
/
data-shares
Create data share
curl --request POST \
  --url https://api.royalti.io/data-shares \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sourceTenantId": 93,
  "targetTenantId": 12,
  "filterValues": [
    "GBCVZ1234567",
    "GBCVZ7654321"
  ],
  "filterType": "isrc",
  "filterMode": "include",
  "feeRate": 0.1,
  "feeType": "percentage",
  "notes": "<string>"
}
'
import requests

url = "https://api.royalti.io/data-shares"

payload = {
    "sourceTenantId": 93,
    "targetTenantId": 12,
    "filterValues": ["GBCVZ1234567", "GBCVZ7654321"],
    "filterType": "isrc",
    "filterMode": "include",
    "feeRate": 0.1,
    "feeType": "percentage",
    "notes": "<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({
    sourceTenantId: 93,
    targetTenantId: 12,
    filterValues: ['GBCVZ1234567', 'GBCVZ7654321'],
    filterType: 'isrc',
    filterMode: 'include',
    feeRate: 0.1,
    feeType: 'percentage',
    notes: '<string>'
  })
};

fetch('https://api.royalti.io/data-shares', 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/data-shares",
  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([
    'sourceTenantId' => 93,
    'targetTenantId' => 12,
    'filterValues' => [
        'GBCVZ1234567',
        'GBCVZ7654321'
    ],
    'filterType' => 'isrc',
    'filterMode' => 'include',
    'feeRate' => 0.1,
    'feeType' => 'percentage',
    '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/data-shares"

	payload := strings.NewReader("{\n  \"sourceTenantId\": 93,\n  \"targetTenantId\": 12,\n  \"filterValues\": [\n    \"GBCVZ1234567\",\n    \"GBCVZ7654321\"\n  ],\n  \"filterType\": \"isrc\",\n  \"filterMode\": \"include\",\n  \"feeRate\": 0.1,\n  \"feeType\": \"percentage\",\n  \"notes\": \"<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/data-shares")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"sourceTenantId\": 93,\n  \"targetTenantId\": 12,\n  \"filterValues\": [\n    \"GBCVZ1234567\",\n    \"GBCVZ7654321\"\n  ],\n  \"filterType\": \"isrc\",\n  \"filterMode\": \"include\",\n  \"feeRate\": 0.1,\n  \"feeType\": \"percentage\",\n  \"notes\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/data-shares")

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  \"sourceTenantId\": 93,\n  \"targetTenantId\": 12,\n  \"filterValues\": [\n    \"GBCVZ1234567\",\n    \"GBCVZ7654321\"\n  ],\n  \"filterType\": \"isrc\",\n  \"filterMode\": \"include\",\n  \"feeRate\": 0.1,\n  \"feeType\": \"percentage\",\n  \"notes\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "message": "Data share created",
  "data": {
    "id": 1,
    "sourceTenantId": 93,
    "targetTenantId": 12,
    "filterType": "isrc",
    "filterMode": "include",
    "filterValues": [
      "GBCVZ1234567",
      "GBCVZ7654321"
    ],
    "feeRate": 0.1,
    "feeType": "percentage",
    "notes": "Sub-distribution deal for Africori catalog",
    "isActive": true,
    "sourceTenant": {
      "id": 5,
      "name": "Star Makers"
    },
    "targetTenant": {
      "id": 5,
      "name": "Star Makers"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}
{
  "status": "error",
  "message": "Invalid request parameters"
}
{
  "status": "error",
  "message": "Unauthorized"
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Code Examples

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

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

import requests

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

data = response.json()
print(data)

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

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
sourceTenantId
integer
required
Example:

93

​
targetTenantId
integer
required
Example:

12

​
filterValues
string[]
required
Example:
["GBCVZ1234567", "GBCVZ7654321"]
​
filterType
enum<string>
default:isrc
Available options:
isrc,
upc,
label,
catalog
​
filterMode
enum<string>
default:include
Available options:
include,
exclude
​
feeRate
number | null
Example:

0.1

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

Response

Data share created

​
status
string
Example:

"success"

​
message
string
Example:

"Data share created"

​
data
object