Skip to main content
PUT
/
split
/
{id}
Update Split
curl --request PUT \
  --url https://api.royalti.io/split/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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
    }
  ]
}
'
{
  "message": "Split was updated successfully."
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

/split/ Description:
The /split/{splitId} endpoint allows updating the details of a specific split identified by their unique splitId. Method:
PUT

​
Code Examples

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);

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Split ID

Body

application/json
​
split
object[]
required

An array of objects containing user shares

​
asset
string<uuid> | null

The UUID of the asset related to the revenue

​
product
string<uuid> | null

The UUID of the product related to the revenue

​
type
string | null

The type of revenue (e.g., Publishing, YouTube, Live)

​
startDate
string<date> | null

The start date of the split period (inclusive)

​
endDate
string<date> | null

The end date of the split period (exclusive)

​
name
string | null

The name or description of the revenue split

​
contract
string | null
​
ContractId
string<uuid> | null
​
memo
string | null
​
conditions
object[] | null

Conditions for split matching

Response

Success

​
message
string