Skip to content

by Startups.Studio

Growth Prospect

Prospect.create

POST /{namespace}/prospects

Creates a Prospect.

Noun: Prospect
Mode: do
Event: Prospect.created

You, to your agent

Add a prospect to Kiln Bakery.

curl -X POST https://api.sb/kilnbakery.com/prospects \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"foundIn":"Example found in","basis":"Example basis"}'

import { $ } from 'startup-builder'

const prospect = await $.Prospect.create({ foundIn: 'Example found in', basis: 'Example basis' })

npx startup-builder do Prospect.create --json '{"foundIn":"Example found in","basis":"Example basis"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Prospect.create({ foundIn: 'Example found in', basis: 'Example basis' })"
  }
}

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

Inputs

Input	Type	Required	Description
`foundIn`	`string`	required	Where the Startup found them.
`basis`	`string`	required	The legal basis for contacting them.
`acquisition`	Acquisition		A Prospect’s Acquisition names the outbound Play and Mailbox that first reached it.

Outputs

Output	Type	Required	Description
`prospect`	Prospect	required	The Prospect.

Effects

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

Prospect

Previous Page

Prospect.delete

Next Page