POST
/api/v2/referrals/programs/{programId}/bulk/{jobId}/executePOST /api/v2/referrals/programs/{programId}/bulk/{jobId}/execute
Authentication
Send your API key in the x-api-key header on every request.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| programId (path) | string (uuid) | Yes | |
| jobId (path) | string (uuid) | Yes |
Request body
application/json
| Field | Type | Required | Description |
|---|---|---|---|
| PayloadHash | string | Yes | |
| IdempotencyKey | string | Yes | |
| SelectedRows | array of unknown | No | Omit for all-or-nothing. Explicit row numbers opt in to executing only these valid rows atomically. |
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/{jobId}/execute" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"PayloadHash":"…","IdempotencyKey":"…"}'This page is generated from the live OpenAPI specification and always matches the current API.