Skip to content

by Startups.Studio

Person.create

POST /{namespace}/people

Creates a Person.

Noun: Person
Mode: do
Event: Person.created

You, to your agent

Add a person to ShiftNote.

curl -X POST https://api.sb/shiftnote.app/people \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"ShiftNote"}'

import { $ } from 'startup-builder'

const person = await $.Person.create({ name: 'ShiftNote' })

npx startup-builder do Person.create --json '{"name":"ShiftNote"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Person.create({ name: 'ShiftNote' })"
  }
}

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

Inputs

Input	Type	Required	Description
`name`	`string`	required	The legal or personal name.
`verified`	`boolean`		True once the identity is verified.

Outputs

Output	Type	Required	Description
`person`	Person	required	The Person.

Effects

Emits Person.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.	Person.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`.