POST
/api/v2/referrals/programs/{programId}/bulk/previewPOST /api/v2/referrals/programs/{programId}/bulk/preview
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 |
|---|---|---|---|
| Csv | string | Yes | |
| ExpectedProgramRevision | unknown | No |
Responses
200 — OK
| Field | Type | Required | Description |
|---|---|---|---|
| Id | string (uuid) | Yes | |
| ProgramId | string (uuid) | Yes | |
| ProgramRevision | unknown | Yes | |
| PayloadHash | string | Yes | |
| ExpiresAt | string (date-time) | Yes | |
| Status | string | Yes | |
| ExecutedAt | string (date-time) | Yes | |
| Rows | array of ReferralBulkRowResponse | Yes |
Example request
curl -X POST "https://{base_url}/api/v2/referrals/programs/{programId}/bulk/preview" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"Csv":"…"}'This page is generated from the live OpenAPI specification and always matches the current API.