POST Parameters:
Parameter | Type | Required | Description |
---|---|---|---|
asset | string | Yes | The UUID of the asset related to the revenue |
product | string | Yes | The UUID of the product related to the revenue |
type | string | No | The type of revenue (e.g., Publishing, YouTube, Live) |
startDate | string | No | The start date of the split period (inclusive) |
endDate | string | No | The end date of the split period (exclusive) |
name | string | No | The name or description of the revenue split |
conditions | array | No | Array of condition objects for split matching |
contract | string | No | Contract details |
ContractId | string | No | Contract ID |
memo | string | No | Additional notes |
split | array | Yes | An array of objects containing user shares |
Authentication
This endpoint requires authentication. Include your bearer token in the Authorization header.Request Body
Request Schema
Field | Type | Required | Description |
---|---|---|---|
asset | string | ❌ | The UUID of the asset related to the revenue |
product | string | ❌ | The UUID of the product related to the revenue |
type | string | ❌ | The type of revenue (e.g., Publishing, YouTube, Live) |
startDate | string | ❌ | The start date of the split period (inclusive) |
endDate | string | ❌ | The end date of the split period (exclusive) |
name | string | ❌ | The name or description of the revenue split |
split | array | ✅ | An array of objects containing user shares |
conditions | array | ❌ | Conditions for split matching |
contract | string | ❌ | |
ContractId | string | ❌ | |
memo | string | ❌ |
Responses
✅ 201 - Split created successfully
⚠️ 400 - Split condition error
⚠️ 401 - Unauthorized
⚠️ 404 - Not Found
❌ 500 - Internal Server Error
Tags
Splits
Authorizations
JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"
Body
application/json
An array of objects containing user shares
The UUID of the asset related to the revenue
The UUID of the product related to the revenue
The type of revenue (e.g., Publishing, YouTube, Live)
The start date of the split period (inclusive)
The end date of the split period (exclusive)
The name or description of the revenue split
Conditions for split matching