Skip to main content
PUT
/
product
/
bulksplits
Update Bulk Product Splits
curl --request PUT \
  --url https://api.royalti.io/product/bulksplits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "updates": [
    {
      "productId": "<string>",
      "split": [
        {
          "user": "<string>",
          "share": 123
        }
      ]
    }
  ]
}
'
{
  "id": "prod_123456",
  "title": "Summer Vibes",
  "displayArtist": "John Doe feat. Jane Smith",
  "upc": "123456789012",
  "catalogNumber": "CAT-2024-001",
  "type": "Audio",
  "format": "Single",
  "explicit": false,
  "releaseDate": "2024-06-15",
  "takedownDate": null,
  "mainGenre": "Pop",
  "subGenre": "Dance Pop",
  "status": "active",
  "version": "Deluxe Edition",
  "label": "Indie Records",
  "copyright": "2024 John Doe",
  "publisher": "Music Publishing Co.",
  "media": [
    {
      "id": "<string>",
      "url": "<string>",
      "type": "<string>",
      "mimetype": "<string>"
    }
  ],
  "artists": [
    {
      "id": "<string>",
      "name": "<string>",
      "type": "primary"
    }
  ],
  "assets": [
    {
      "id": "<string>",
      "title": "<string>",
      "isrc": "<string>",
      "number": 123
    }
  ],
  "distribution": {},
  "contributors": [
    {}
  ],
  "metadata": {},
  "createdAt": "2024-08-25T10:30:00Z",
  "updatedAt": "2024-08-25T10:30:00Z"
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

/product/bulksplits Description:
The /product/bulksplits endpoint allows updating splits for multiple products simultaneously. Method:
PATCH Request Payload:
ParameterTypeDescription
updatesarrayAn array of product split update objects.

​
Code Examples

const response = await fetch('https://api.royalti.io/product/bulksplits', {
  method: 'PUT',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "updates": [
      {
        "productId": "sample-productId",
        "split": [
          {
            "user": "sample-user",
            "share": 1
          }
        ]
      }
    ]
  })
});

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
​
updates
object[]
required

Response

Product created successfully

​
id
string

Unique product identifier

Example:

"prod_123456"

​
title
string

Product title

Example:

"Summer Vibes"

​
displayArtist
string

Display artist name

Example:

"John Doe feat. Jane Smith"

​
upc
string

Universal Product Code

Example:

"123456789012"

​
catalogNumber
string

Catalog number

Example:

"CAT-2024-001"

​
type
enum<string>
Available options:
Audio,
Video
Example:

"Audio"

​
format
enum<string>

Product format (auto-determined by asset count)

Available options:
Single,
EP,
Album
Example:

"Single"

​
explicit
boolean
Example:

false

​
releaseDate
string<date>
Example:

"2024-06-15"

​
takedownDate
string<date> | null
Example:

null

​
mainGenre
string
Example:

"Pop"

​
subGenre
string
Example:

"Dance Pop"

​
status
string
Example:

"active"

​
version
string
Example:

"Deluxe Edition"

​
label
string

Record label (from artist defaults)

Example:

"Indie Records"

​
copyright
string

Copyright information (from artist defaults)

Example:

"2024 John Doe"

​
publisher
string

Publisher information (from artist defaults)

Example:

"Music Publishing Co."

​
media
object[]

Associated media files (artwork, etc.)

​
artists
object[]

Associated artists

​
assets
object[]

Associated media assets

​
distribution
object

Distribution settings

​
contributors
object[]

Contributors list

​
metadata
object

Additional metadata

​
createdAt
string<date-time>

Creation timestamp

Example:

"2024-08-25T10:30:00Z"

​
updatedAt
string<date-time>

Last update timestamp

Example:

"2024-08-25T10:30:00Z"