POST
/api/v2/referrals/programs/{programId}/boosts/{boostId}/pausePOST /api/v2/referrals/programs/{programId}/boosts/{boostId}/pause
Authentication
Send your API key in the x-api-key header on every request.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| programId (path) | string (uuid) | Yes | |
| boostId (path) | string (uuid) | Yes |
Request body
application/json
| Field | Type | Required | Description |
|---|---|---|---|
| ExpectedProgramRevision | unknown | Yes |
Responses
200 — OK
| Field | Type | Required | Description |
|---|---|---|---|
| Id | string (uuid) | Yes | |
| Name | string | Yes | |
| Kind | string | Yes | |
| Status | string | Yes | |
| StartsAt | string (date-time) | Yes | |
| EndsAt | string (date-time) | Yes | |
| Multiplier | unknown | Yes | |
| QualifiedFriendCount | unknown | Yes | |
| MilestoneAmount | unknown | Yes | |
| MaximumIncrementalReward | unknown | Yes | |
| MaximumAwards | unknown | Yes | |
| FundedBudget | unknown | Yes | |
| Currency | string | Yes | |
| AllocatedAwards | unknown | Yes | |
| ReservedBudget | unknown | Yes | |
| PolicyHash | string | Yes |
Example request
curl -X POST "https://{base_url}/api/v2/referrals/programs/{programId}/boosts/{boostId}/pause" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"ExpectedProgramRevision":"…"}'This page is generated from the live OpenAPI specification and always matches the current API.