> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.royalti.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Update Split
> **/split/{splitId}**
This endpoint requires authentication. Include your Bearer token in the Authorization header.
## Description
**/split/{splitId}**
**Description:**\
The `/split/{splitId}` endpoint allows updating the details of a specific split identified by their unique splitId.
**Method:**\
`PUT`
## Code Examples
```javascript Node.js theme={null}
const response = await fetch('https://api.royalti.io/split/example-id', {
method: 'PUT',
headers: {
'Authorization': `Bearer ${token}`,
'Content-Type': 'application/json'
},
body: JSON.stringify({
"asset": "sample-asset",
"product": "sample-product",
"type": "sample-type",
"startDate": "2024-01-21",
"endDate": "2024-01-21",
"name": "sample-name",
"contract": "sample-contract",
"ContractId": "sample-ContractId",
"memo": "sample-memo",
"split": [
{
"ref": "#/components/schemas/SplitShare"
}
],
"conditions": [
{
"mode": "sample-mode",
"memo": "sample-memo",
"territories": [
{}
],
"dsps": [
{}
],
"usageTypes": [
{}
],
"customDimension": "sample-customDimension",
"customValues": [
{}
]
}
]
})
});
const data = await response.json();
console.log(data);
```
```python Python theme={null}
import requests
response = requests.put(
'https://api.royalti.io/split/example-id',
headers={
'Authorization': f'Bearer {token}'
},
json={"asset":"sample-asset","product":"sample-product","type":"sample-type","startDate":"2024-01-21","endDate":"2024-01-21","name":"sample-name","contract":"sample-contract","ContractId":"sample-ContractId","memo":"sample-memo","split":[{"ref":"#/components/schemas/SplitShare"}],"conditions":[{"mode":"sample-mode","memo":"sample-memo","territories":[{}],"dsps":[{}],"usageTypes":[{}],"customDimension":"sample-customDimension","customValues":[{}]}]}
)
data = response.json()
print(data)
```
```bash cURL theme={null}
curl -X PUT https://api.royalti.io/split/example-id \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"asset":"sample-asset","product":"sample-product","type":"sample-type","startDate":"2024-01-21","endDate":"2024-01-21","name":"sample-name","contract":"sample-contract","ContractId":"sample-ContractId","memo":"sample-memo","split":[{"ref":"#/components/schemas/SplitShare"}],"conditions":[{"mode":"sample-mode","memo":"sample-memo","territories":[{}],"dsps":[{}],"usageTypes":[{}],"customDimension":"sample-customDimension","customValues":[{}]}]}'
```
## OpenAPI
````yaml put /split/{id}
openapi: 3.0.0
info:
title: Royalti.io API
description: "# Royalti API\r\n\r\nThis is the Royalti music royalty management platform API server.\r\n\r\n## Overview\r\n\r\nThe Royalti API provides comprehensive music royalty management services including:\r\n- Music publishing and writer management\r\n- Royalty processing and analytics\r\n- DDEX integration for music industry standards\r\n- File processing and pattern recognition\r\n- Payment processing and distribution\r\n\r\n## Authentication\r\n\r\nThe API uses JWT-based authentication with multiple protection levels:\r\n- Public endpoints for basic operations\r\n- Protected endpoints requiring valid JWT tokens\r\n- Admin endpoints for administrative functions\r\n\r\n## Features\r\n\r\n- Multi-dimensional royalty analytics\r\n- CWR (Collective Works Registration) support\r\n- DDEX integration for music metadata\r\n- Advanced file processing with pattern recognition\r\n- Real-time data processing with queue system"
version: 2.6.0
contact:
name: Royalti.io Support
email: support@royalti.io
url: https://royalti.io
license:
name: Proprietary
url: https://royalti.io/terms
servers:
- url: https://api.royalti.io
description: Production server
- url: https://api-dev.royalti.io
description: Development server
- url: http://localhost:8084
description: Local development
security:
- bearerAuth: []
tags:
- name: Accounting
description: Accounting and financial transaction operations
- name: DDEX
description: DDEX operations (ERN/MEAD, messages, delivery, providers)
- name: Label
description: Label management operations
- name: Internal Webhooks
description: Internal system webhooks for royalty processing and downloads
- name: Payment Webhooks
description: Payment processor webhook endpoints
- name: Billing Webhooks
description: Stripe billing and subscription webhooks
- name: Infrastructure Webhooks
description: Cloudflare domain and SSL webhooks
- name: Distribution Webhooks
description: Digital distribution platform webhooks (FUGA)
paths:
/split/{id}:
put:
tags:
- Splits
summary: Update Split
description: >-
**/split/{splitId}**
**Description:**
The `/split/{splitId}` endpoint allows updating the details of a
specific split identified by their unique splitId.
**Method:**
`PUT`
parameters:
- name: id
in: path
required: true
description: Split ID
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
asset:
type: string
format: uuid
nullable: true
description: The UUID of the asset related to the revenue
product:
type: string
format: uuid
nullable: true
description: The UUID of the product related to the revenue
type:
type: string
nullable: true
description: The type of revenue (e.g., Publishing, YouTube, Live)
startDate:
type: string
format: date
nullable: true
description: The start date of the split period (inclusive)
endDate:
type: string
format: date
nullable: true
description: The end date of the split period (exclusive)
name:
type: string
nullable: true
description: The name or description of the revenue split
contract:
type: string
nullable: true
ContractId:
type: string
format: uuid
nullable: true
memo:
type: string
nullable: true
split:
type: array
items:
$ref: '#/components/schemas/SplitShare'
description: An array of objects containing user shares
conditions:
type: array
nullable: true
items:
type: object
properties:
mode:
type: string
enum:
- include
- exclude
default: include
memo:
type: string
nullable: true
territories:
type: array
items:
type: string
dsps:
type: array
items:
type: string
usageTypes:
type: array
items:
type: string
customDimension:
type: string
customValues:
type: array
items:
type: string
description: Conditions for split matching
required:
- split
example:
asset: d1c5b49e-95fa-4aed-930e-cf314c16a53d
product: null
type: Publishing
startDate: '2022-01-01'
endDate: '2022-01-31'
name: Updated Nigerian split train
split:
- user: cf960b5a-37cd-484a-b461-0b191b09bed1
share: 70
- user: 4e39b347-7db0-417d-a5bc-3d8493c9ce19
share: 30
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
message:
type: string
example:
message: Split was updated successfully.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- bearerAuth: []
components:
schemas:
SplitShare:
type: object
properties:
user:
type: string
format: uuid
description: The unique identifier of the user
share:
type: integer
minimum: 0
maximum: 100
description: The percentage share of the revenue for the user
Error:
type: object
properties:
success:
type: boolean
example: false
error:
type: object
properties:
code:
type: string
message:
type: string
details:
type: array
items:
type: string
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: >-
JWT Authorization header using the Bearer scheme. Format: "Bearer
{token}"
````