Skip to content

by Startups.Studio

Share.transfer

POST /{namespace}/shares/{share}/transfer

Transfer moves Shares from one Holder to another under a signed Agreement, within the Company’s transfer restrictions.

Noun: Share
Mode: do
Event: Share.transferred

You, to your agent

Transfer the latest share with a holder and an agreement.

curl -X POST https://api.sb/kilnbakery.com/shares/share_1/transfer \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to":"holder_1","quantity":1,"agreement":"agreement_1"}'

import { $ } from 'startup-builder'

const share = await $.Share.transfer({ share: 'share_1', to: 'holder_1', quantity: 1, agreement: 'agreement_1' })

npx startup-builder do Share.transfer --json '{"share":"share_1","to":"holder_1","quantity":1,"agreement":"agreement_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Share.transfer({ share: 'share_1', to: 'holder_1', quantity: 1, agreement: 'agreement_1' })"
  }
}

Inputs

Input	Type	Required	Description
`share`	Share	required	The Share record to transfer from.
`to`	Holder	required	The Holder who receives them.
`quantity`	`integer`	required	How many Shares move.
`agreement`	Agreement	required	The signed transfer Agreement.

Outputs

Output	Type	Required	Description
`share`	Share	required	The new Share record held by the receiving Holder.

Effects

Emits Share.transferred.
Performed by the Legal Lead.
One-way: it waits out its delay window, and runs in the send and do modes.
Refuses a transfer the bylaws or a right of first refusal block.
Keeps the original record; a transfer writes a pair of records, never an edit.

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.	Share.transfer
A transfer the bylaws or a right of first refusal block	`refused`	Clear what the check names, then call it again.	Share.transfer

When it waits

Gate	Default
Decision class	Medium: one-way, bounded
Delay window	1 business hour, in which a watcher can pause, redirect or cancel it; then it runs.
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`.

Share.list

Previous Page

Statement

Next Page