Skip to content

by Startups.Studio

Team Worker Human

Human.invite

POST /{namespace}/humans/invite

Invite asks a person to join a Startup in a named Role, sharing that Role’s work with its Agent.

Noun: Human
Mode: do
Event: Human.invited

You, to your agent

Invite Lena Fischer with a role.

curl -X POST https://api.sb/petpantry.shop/humans/invite \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"lena@petpantry.shop","role":"role_1"}'

import { $ } from 'startup-builder'

const human = await $.Human.invite({ email: 'lena@petpantry.shop', role: 'role_1' })

npx startup-builder do Human.invite --json '{"email":"lena@petpantry.shop","role":"role_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Human.invite({ email: 'lena@petpantry.shop', role: 'role_1' })"
  }
}

Inputs

Input	Type	Required	Description
`email`	`email`	required	Where the invitation goes.
`role`	Role	required	The Role offered.
`access`	`string`		The Access Level the person holds in the app, apart from the Role: `admin`, `member` or `viewer`. Owner is never invited.

Outputs

Output	Type	Required	Description
`human`	Human	required	The invited Human.

Effects

Emits Human.invited.
Performed by the Recruiter.
Staffs the Role with the Human once they accept.
Grants the Access Level named in access once they accept.

Refuses when

Check	Error	Fix	Then call
The input does not match the schema of the operation.	`invalid-input`	Read the schema of the operation, then send every required field with the right type.	Human.invite
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.	Human.invite
The record changed since it was read, so the write would overwrite a newer version.	`conflict`	Read the record again, then retry the write against its current state.	Human.invite

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

Human.hold

Previous Page

Human.list

Next Page