Referral routes: update, delete

Reference for Referral, one group of Referral routes.

Referral.update

Changes the given properties of a Referral. Verb page.

Text

PATCH /{namespace}/referrals/{id}

Path: id. Body, as JSON: the other inputs. Emits Referral.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Referral.
`reward`	`money`		What the referrer earns.
`rewardKind`	`string`		What the referrer earns: earlier `access`, or `cash`, which pays only after Live.

Returns

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

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.	None.

Example

Terminal

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

JSON

{
  "api": "https://api.sb/leaseline.app",
  "referral": {
    "$id": "https://api.sb/leaseline.app/referrals/referral_I89J7wngKt",
    "$type": "Referral",
    "reward": {
      "amount": 29,
      "currency": "USD"
    },
    "rewardKind": "access"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Referral.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Referral.delete

Deletes a Referral: a soft delete that keeps its history, undone by Thing.restore. Verb page.