Skip to main content
POST
/
sources
curl --request POST \
  --url https://api.royalti.io/sources \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "royaltySourceId": "src-1",
  "settings": {},
  "replacements": {}
}
'
{
  "TenantId": 1,
  "RoyaltySourceId": "src-1",
  "isActive": true,
  "settings": {},
  "replacements": {}
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

​
Mode 1: Add by Source ID (royaltySourceId)

Add a specific source variant by its UUID.

​
Mode 2: Add by Source Name (sourceName)

Add a source by name. The system automatically selects the current variant (the one with no end date, or the most recent if all have end dates). Note: The system will automatically associate additional variants as needed when processing royalty files with different date ranges.

​
Required Role

  • admin or owner role within the tenant

​
Business Rules

  • Must provide either royaltySourceId OR sourceName (not both)
  • Source must have public=true and isActive=true to be associated
  • Cannot add duplicate associations
  • Association is automatically set to isActive=true on creation

​
Side Effects

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

​
Code Examples

const response = await fetch('https://api.royalti.io/sources', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "royaltySourceId": "src-1",
    "sourceName": "alterk",
    "settings": {},
    "replacements": {}
  })
});

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

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
royaltySourceId
string

UUID of a specific royalty source variant to associate. Use this OR sourceName, not both.

Example:

"src-1"

​
sourceName
string

Name of the source to associate ALL variants of (case-insensitive). Use this OR royaltySourceId, not both. Example: "africori", "alterk", "spotify"

Example:

"alterk"

​
settings
object

Tenant-specific settings for this source

Example:
{}
​
replacements
object

Field mapping/replacement rules

Example:
{}

Response

Tenant source association created

Association between a tenant and a royalty source. Note: The composite key is (TenantId, RoyaltySourceId).

​
TenantId
integer

Tenant ID (automatically set from authenticated user)

Example:

1

​
RoyaltySourceId
string

Royalty source ID

Example:

"src-1"

​
isActive
boolean
default:true

Whether this source association is active for the tenant

Example:

true

​
settings
object

Tenant-specific settings for this source

Example:
{}
​
replacements
object

Tenant-specific field replacements/mappings

Example:
{}
​
royaltySource
object