Delete Payout Group

Deletes a payout group. Deleting a payout group which has an on-chain component will cause the unclaimed rewards for that group to be implicitly claimed. No details of the implicit claiming are returned in this API response.

DELETE /rewards/payout-groups/{id}

Delete Payout Group

cURL

curl --request DELETE \
  --url https://api.example.com/rewards/payout-groups/{id} \
  --header 'Authorization: Bearer <token>'

200

{}

OAuth Scope

rewards:write_payout_groups

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id · string · required

UUID direct reference to the payout group to delete.

Response

200 - application/json

A successful response.

The response is of type object.