Skip to content

How the partner API works

The partner API connects your own referral program to suly.gg. Video creators find your program in the suly.gg catalog and join it; your platform gives each of them a referral code and a link, and later tells suly.gg how much to pay each creator. suly.gg pays creators from the budget you funded.

suly.gg never calculates your revenue or the creators’ share. Your system decides every amount; suly.gg carries the codes, the notes and the money.

Step You (the partner) suly.gg
Offer Create a revenue-share offer in the business cabinet and fund its budget Reviews the offer and shows it in the catalog
Creators Pick up new creators through the API and give each a code and a link, or decline them Shows the code and the link on the creator’s offer page
Tracking Count referrals, deposits and your own levels in your system Nothing: referral activity stays on your side
Status Optionally send each creator a note: referrals counted, level, next payout Shows the note to that creator
Payouts Send accruals: creator, amount, your operation number Moves the amount to the creator at once and charges the fee from the offer budget
  • The offer budget is moved from your business balance when you send the offer to moderation. You can add budget at any time without a new review.
  • Each accrual takes the amount plus the suly.gg fee from the budget. The creator receives the amount in full. The current fee is returned by GET /program as feePercent.
  • The creator can withdraw an accrual at once. An accrual cannot be reversed through the API.
  • When the budget cannot cover an accrual, the request fails with INSUFFICIENT_BUDGET and the offer is hidden from new creators until you add budget. Creators who already joined keep their codes.
  • Your offer text: description, what to do, materials, the percent and what it is counted from.
  • Their code and link, with copy buttons.
  • Your note to them, with the time it was updated.
  • Every accrual with your comment, on the offer page and in their earnings.

The creator does not see referral counts, levels or open settlement cycles unless you send them in a note.