Create Program

Create a Program in one step: name, kind (referral or loyalty), landing page URL, and optionally Widget settings, brand color, partner applications, and benefit rules with their first terms. A new Program is active at once. 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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

projectId*string

Length1 <= length <= 128

name*string

Length1 <= length <= 100

kind?string

Default"referral"

Value in

"referral"
"loyalty"

landingPageUrl*string

Match^https?:\/\/[^/?#\s]+

widgetConfig?

primaryColor?string

Match^#[0-9A-Fa-f]{6}$

partnerApplicationsOpen?boolean

rules?array<>

Itemsitems <= 20

Response Body

`application/json`

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

{  "success": true,  "data": {}}

Create Program

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`