PATCH /v1/admin/companies/{company}/payouts/status

Update the company payout status (admin only)

Path parameters

  • company string Required

    Format should match the following pattern: co_[a-zA-Z0-9]+.

application/json

Body

Update payout status request body

  • payoutStatus string

    Values are disabled, pending, or enabled.

Responses

  • 204

    Payout status updated successfully

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Company not found

  • 422

    Validation Error

PATCH /v1/admin/companies/{company}/payouts/status
curl \
 --request PATCH 'https://api-dev.classmanager.io/v1/admin/companies/{company}/payouts/status' \
 --header "Content-Type: application/json" \
 --data '{"payoutStatus":"disabled"}'
Request examples
{
  "payoutStatus": "disabled"
}