H!HOPPA
POST/api/v2/users/{userId}/referrals/vouchers/redeem-all

Initiates all eligible assigned vouchers through the existing voucher processor.

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
FieldTypeRequiredDescription
userId (path)integer (int32)Yes

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
EligibleunknownYes
InitiatedunknownYes
AlreadyProcessingunknownYes
SkippedunknownYes
FailedunknownYes
Resultsarray of RedeemAssignedVoucherResultYes

Example request

curl -X POST "https://{base_url}/api/v2/users/{userId}/referrals/vouchers/redeem-all" \
  -H "x-api-key: YOUR_API_KEY"

This page is generated from the live OpenAPI specification and always matches the current API.