Skip to main content
DELETE
/
sources
/
{id}
Remove Tenant Source by RoyaltySource ID
curl --request DELETE \
  --url https://api.royalti.io/sources/{id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.royalti.io/sources/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.delete(url, headers=headers)

print(response.text)
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.royalti.io/sources/{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/sources/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.royalti.io/sources/{id}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.delete("https://api.royalti.io/sources/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "message": "Source removed successfully"
}
{
  "status": "error",
  "message": "Unauthorized"
}
{
  "success": false,
  "error": {
    "code": "403",
    "message": "Only workspace admins can remove royalty sources"
  }
}
{
  "success": false,
  "error": {
    "code": "404",
    "message": "Source association not found"
  }
}
{
  "status": "error",
  "message": "Internal server error"
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

​
Required Role

  • admin or owner role within the tenant

​
Important: ID Parameter

The id parameter represents the RoyaltySource ID, not the TenantSource association ID. This endpoint deletes the tenant’s source association WHERE RoyaltySourceId = id AND TenantId = authenticated_tenant.

​
Business Rules

  • Can only remove own tenant’s associations
  • Permanently removes the association (does not just deactivate)
  • Does NOT delete the underlying RoyaltySource record

​
Side Effects

  • Triggers regeneration of tenant’s sales data query cache
  • Updates tenant-specific BigQuery query configurations

​
Alternative: Deactivate Instead

If you want to temporarily disable a source without removing it, use the POST /sources/{id}/deactivate endpoint instead. This preserves the association and settings for potential reactivation later. Authorization:
  • Required role: admin or higher

​
Code Examples

const response = await fetch('https://api.royalti.io/sources/example-id', {
  method: 'DELETE',
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

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

import requests

response = requests.delete(
  'https://api.royalti.io/sources/example-id',
  headers={
    'Authorization': f'Bearer {token}'
  },
)

data = response.json()
print(data)

curl -X DELETE https://api.royalti.io/sources/example-id \
  -H "Authorization: Bearer YOUR_TOKEN" \

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

RoyaltySource ID (not TenantSource ID)

Example:

"src-1"

Response

Source removed successfully

​
message
string
Example:

"Source removed successfully"