Referral Program

referral-program

Design customer referral or affiliate programs: virality check first, trigger moments, dual-sided rewards, and program metrics.

Pricing & runtime

Current price: 25 Credits per run
Timeout: up to 900s
Brand Context: Optional — pass a brand_context_id

Prices are calibrated against real run costs and may change — the credit_cost returned when creating a run is authoritative.

Input parameters

Pass these under the input object of POST /api/v1/runs.

Key	Type	Required	Label & description
product_description	short_text	Required	ProductWhat the product is.
program_type	select	Optional	Program typeReferral, affiliate, or let it decide.Options: Customer referral, Affiliate, Let it decide
current_state	long_text	Optional	Current stateExisting program and results, if any.
product_fit	short_text	Optional	ShareabilityShareable? Network effects? Do customers talk about it?
resources	short_text	Optional	ResourcesTooling and incentive budget.
interaction_language	select	Optional	Report languageControls the language of the generated report.Options: English, Chinese

Request example

Covers every required field. Optional fields follow the same pattern.

curl -X POST https://api.TODO-APP-DOMAIN/api/v1/runs \
  -H "Authorization: Bearer $SUPAMARKETERS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "app_slug": "referral-program",
  "input": {
    "product_description": "example text"
  }
}'

What you get back

A 201 response returns run_no, credit_cost, stream_url and result_url (relative paths). Stream progress from stream_url and fetch the terminal result — summary and output — from result_url. Results stay available for the App's retention window (30 days by default).