PUT
/api/v2/referrals/programPUT /api/v2/referrals/program
Authentication
Send your API key in the x-api-key header on every request.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| programId (query) | string (uuid) | No |
Request body
application/json
| Field | Type | Required | Description |
|---|---|---|---|
| MaximumRecurringReward | unknown | No | |
| Name | string | Yes | |
| Description | string | No | Shown to members on the offer panel instead of the generated explanation when set. |
| Visibility | string | Yes | |
| Revision | unknown | No | |
| Status | string | Yes | |
| LevelBasis | string | No | Deprecated and optional. SUCCESSFUL_REFERRAL_COUNT or REFERRED_TOPUP_VOLUME; stored as is, decides nothing. |
| LevelLookbackMonths | unknown | No | |
| EarningWindowDays | unknown | No | |
| EarningWindowStart | string | Yes | |
| QualifyRequiresKyc | boolean | No | |
| QualifyRequiresPaidCard | boolean | No | |
| QualifyRequiresTopup | boolean | No | |
| QualifyMinimumTopup | unknown | No | Null means the platform card top-up minimum applies. |
| WelcomeAmount | unknown | No | |
| WelcomeCurrency | string | Yes | |
| DeliveryMode | string | Yes | |
| PayoutCurrency | string | Yes | |
| VoucherClaimDays | unknown | No | |
| MinimumCreditAmount | unknown | No | |
| MaxEligibleVolumePerRelationship | unknown | No | |
| ExposureLimit | unknown | No | |
| TermsText | string | No | |
| PrivacyNotice | string | No | |
| PublishNewTermsVersion | boolean | No | When true the terms version is bumped even if rates did not change. |
| 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 | |
| EarningWindowDays | unknown | Yes | |
| EarningWindowStart | string | Yes | |
| QualifyRequiresKyc | boolean | Yes | |
| QualifyRequiresPaidCard | boolean | Yes | |
| QualifyRequiresTopup | boolean | Yes | |
| QualifyMinimumTopup | unknown | Yes | |
| WelcomeAmount | unknown | Yes | |
| WelcomeCurrency | string | Yes | |
| DeliveryMode | string | Yes | |
| PayoutCurrency | string | Yes | |
| VoucherClaimDays | unknown | Yes | |
| MinimumCreditAmount | unknown | Yes | |
| MaxEligibleVolumePerRelationship | unknown | Yes | |
| ExposureLimit | unknown | Yes | |
| ReservedExposure | unknown | Yes | |
| TermsVersion | unknown | Yes | |
| TermsText | string | Yes | |
| PrivacyNotice | string | Yes | |
| PublishedAt | string (date-time) | Yes | |
| Levels | array of ReferralLevelResponse | Yes | |
| UpdatedAt | string (date-time) | Yes | |
| Name | string | No | |
| Visibility | string | No | |
| Description | string | No | |
| Revision | unknown | No | |
| OfferVersionId | string (uuid) | No | |
| MarginPolicy | object | No | |
| MaximumRecurringReward | unknown | No |
Example request
curl -X PUT "https://{base_url}/api/v2/referrals/program" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"Name":"…","Visibility":"…","Status":"…","EarningWindowStart":"…"}'This page is generated from the live OpenAPI specification and always matches the current API.