Skip to content

by Startups.Studio

Growth Referral

Referral.create

POST /{namespace}/referrals

Creates a Referral.

Noun: Referral
Mode: do
Event: Referral.created

You, to your agent

Add a referral to ShiftNote.

curl -X POST https://api.sb/shiftnote.app/referrals \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reward":{"amount":79,"currency":"USD"}}'

import { $ } from 'startup-builder'

const referral = await $.Referral.create({ reward: { amount: 79, currency: 'USD' } })

npx startup-builder do Referral.create --json '{"reward":{"amount":79,"currency":"USD"}}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Referral.create({ reward: { amount: 79, currency: 'USD' } })"
  }
}

Create makes a new Referral from the inputs below. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`reward`	`money`		What the referrer earns.
`rewardKind`	`string`		What the referrer earns: earlier `access`, or `cash`, which pays only after Live.
`party`	Party		The Party who sends a Referral earns its reward.

Outputs

Output	Type	Required	Description
`referral`	Referral	required	The Referral.

Effects

Emits Referral.created.
Two-way: try, send, do.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Referral.create

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Referral

Previous Page

Referral.delete

Next Page