PUT
/api/v2/admin/referrals/programPUT /api/v2/admin/referrals/program
Authentication
Send your API key in the x-api-key header on every request.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| companyId (query) | unknown | No |
Request body
application/json
| Field | Type | Required | Description |
|---|---|---|---|
| Status | string | Yes | |
| LevelBasis | string | Yes | |
| LevelLookbackMonths | unknown | No | |
| CommissionEligibilityMonths | unknown | No | |
| DeliveryMode | string | Yes | |
| PayoutCurrency | string | Yes | |
| VoucherClaimDays | unknown | No | |
| Levels | array of UpdateReferralLevelRequest | Yes |
Responses
200 — OK
| Field | Type | Required | Description |
|---|---|---|---|
| Exists | boolean | Yes | |
| Id | string (uuid) | Yes | |
| Provider | string | Yes | |
| Status | string | Yes | |
| LevelBasis | string | Yes | |
| LevelLookbackMonths | unknown | Yes | |
| CommissionEligibilityMonths | unknown | Yes | |
| DeliveryMode | string | Yes | |
| PayoutCurrency | string | Yes | |
| VoucherClaimDays | unknown | Yes | |
| Levels | array of ReferralLevelResponse | Yes | |
| UpdatedAt | string (date-time) | Yes |
Example request
curl -X PUT "https://{base_url}/api/v2/admin/referrals/program" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"Status":"…","LevelBasis":"…","DeliveryMode":"…","PayoutCurrency":"…"}'This page is generated from the live OpenAPI specification and always matches the current API.