Skip to content

Creates a scheduled revenue-share override for a creator group, covering startDate through endDate. Provide a flat revShare for the whole group, override specific tiers via tierRevenueShares, or both. The request is rejected if you send neither.

Only one non-deleted schedule may cover a group’s date range at a time. If the window you request overlaps any other active schedule for the group, the call returns 409 rather than replacing it, and this is not idempotent: calling it twice with the same overlapping window creates the first schedule and rejects the second.

Send revShare and each tierRevenueShares[].revShare as a number from 1 to 100. Internally the value is only converted to a stored fraction when it is greater than 1, so sending exactly 1 (meaning 1%) is stored as a 100% share instead. Avoid sending exactly 1 until this is fixed; see the reported flag.

This method authenticates with a secret (nexus_sk_...) key, so call it from your back-end, never from a game client.

X-SHARED-SECRET
required
stringheader

Send your secret API key (nexus_sk_...) in the X-SHARED-SECRET header. Generate one in the Publisher Dashboard.

groupId
string
Example
V1StGXR8_Z5jdHi6B1LiO

Creator group to schedule the override for. If your key is scoped to a single program, that group is always used regardless of this value; otherwise falls back to your default group when omitted.

Media typeapplication/json
object
revShare

Flat revenue-share percentage for the whole group during this window, 1 to 100. Provide this, tierRevenueShares, or both, at least one is required.

number
Example
25
startDate

Start of the override window. ISO 8601, in UTC.

string format: date-time
Example
2026-03-13T17:32:28Z
endDate

End of the override window. Must be after startDate. ISO 8601, in UTC.

string format: date-time
Example
2026-03-20T17:32:28Z
tierRevenueShares
Array<object>
object
revShare

This tier’s revenue-share percentage for the window, 1 to 100.

number
Example
30
tierId

The tier’s id, as returned by GET /manage/tiers (the tier’s uuid, not its name).

string
Example
2ixlNNFdJh-9scoXek80w

Scheduled rev share that was created

Media typeapplication/json
object
id
string
revShare

Group-wide revenue-share percentage for this schedule’s window (25 means 25%). Falls back to the group’s normal, non-scheduled default when the schedule only carries tier-specific overrides.

number
startDate
string format: date-time
endDate
string format: date-time
groupId
string
groupName
string
tierRevenueShares
Array<object>
object
revShare
number
tierId
string
tierName
string

The request body failed schema validation (missing startDate/endDate, neither revShare nor tierRevenueShares sent, or a revShare outside 1-100), which returns a JSON body with an errors array, or endDate is before startDate, which returns a plain-text message instead.

The resolved creator group (from groupId, your key’s scoped group, or your publisher’s default group) did not match a creator group on your publisher account.

The requested window overlaps another non-deleted revenue share for this group. Only one schedule may cover a given date range.

POST
/manage/scheduled-rev-shares
curl --request POST \
--url 'https://api.nexus.gg/v1/manage/scheduled-rev-shares?groupId=V1StGXR8_Z5jdHi6B1LiO' \
--header 'Content-Type: application/json' \
--header 'X-SHARED-SECRET: nexus_sk_your_key_here' \
--data '{ "revShare": 25, "startDate": "2026-03-13T17:32:28Z", "endDate": "2026-03-20T17:32:28Z", "tierRevenueShares": [ { "revShare": 30, "tierId": "2ixlNNFdJh-9scoXek80w" } ] }'
Example
{
"id": "2ixlNNFdJh-9scoXek80w",
"revShare": 25,
"startDate": "2026-03-13T17:32:28Z",
"endDate": "2026-03-20T17:32:28Z",
"groupId": "V1StGXR8_Z5jdHi6B1LiO",
"groupName": "Aurora Drift Creators",
"tierRevenueShares": [
{
"revShare": 30,
"tierId": "mK4pQ2xR9vLtN0bWdZ7yA",
"tierName": "Silver"
}
]
}