Payouts

Cancel a payout window

Marks a completed billing window as canceled so it is excluded from payout calculations.

post/payouts/cancel

Request

  • Base URL: https://viral.app/api/v1
  • URL: https://viral.app/api/v1/payouts/cancel
  • Auth: API key in header x-api-key

Request body

campaignIdstring required

Campaign ID with orgcamp_ prefix

creatorIdstring required

Organization creator ID with orgcre_ prefix

billingPeriodStartstring date-time required
billingPeriodEndstring date-time required
reasonNotestring

Example request

{
  "campaignId": "orgcamp_RwmraAffhMt9"
}

Response

OK

successunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.