POST
/api/v2/referrals/programs/{programId}/qualification-scenariosPOST /api/v2/referrals/programs/{programId}/qualification-scenarios
Authentication
Send your API key in the x-api-key header on every request.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| programId (path) | string (uuid) | Yes |
Request body
application/json
| Field | Type | Required | Description |
|---|---|---|---|
| DraftId | string (uuid) | No | |
| DraftRevision | unknown | No | |
| Draft | object | No | |
| LevelCode | string | Yes | |
| AttributedAt | string (date-time) | No | |
| AsOf | string (date-time) | No | |
| AlreadyUsedVolume | unknown | No | |
| AlreadyRewarded | unknown | No | |
| BoostId | string (uuid) | No | |
| AlreadyBoostRewarded | unknown | No | |
| AlreadyQualifiedFriends | unknown | No | |
| Team | boolean | No | |
| VerifiedCountry | string | No | |
| Events | array of ReferralQualificationScenarioEvent | No |
Responses
200 — OK
| Field | Type | Required | Description |
|---|---|---|---|
| CalculationVersion | string | Yes | |
| DraftId | string (uuid) | Yes | |
| DraftRevision | unknown | Yes | |
| Qualification | ReferralQualificationDecision | Yes | |
| Steps | array of ReferralQualificationScenarioStep | Yes | |
| EligibleVolumeUsed | unknown | Yes | |
| RecurringRewardUsed | unknown | Yes | |
| Warnings | array of string | Yes |
Example request
curl -X POST "https://{base_url}/api/v2/referrals/programs/{programId}/qualification-scenarios" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"LevelCode":"…"}'This page is generated from the live OpenAPI specification and always matches the current API.