SolutionsPricingDocsStart Free
PlatformAutomationsAPI

Pause Program

POST
/v1/programs/{programId}/pause

Pause a live Program: no new referrals or enrollments, and links open the landing page without tracking. Earlier referrals keep earning Rewards. resume_program undoes it. A write applies at once. Needs the programs:write key permission.

Authorization

WorkspaceApiKey
X-Api-Key<token>

Workspace-owned Better Auth API key of one environment (Sandbox or Live); it authorizes the Projects of that environment in its Workspace. A Project of the other environment returns 403 ENVIRONMENT_MISMATCH. Never expose it in the browser.

In: header

Path Parameters

programId*string
Length1 <= length <= 128

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/programs/string/pause" \  -H "Content-Type: application/json" \  -d '{    "projectId": "string"  }'
{  "success": true,  "data": {}}

Created Webhook

RefRef created a participant: a trusted call or a Widget token named one that the Project did not have, or a partner joined the Project. A partner has no externalId. RefRef POSTs the event to each enabled endpoint of the Project that subscribes to participant.created, and retries for about 72 hours until the endpoint answers 2xx.

Failed Webhook

A payout failed before payment. Its Rewards wait for the next payout. RefRef POSTs the event to each enabled endpoint of the Project that subscribes to payout.failed, and retries for about 72 hours until the endpoint answers 2xx.