Skip to content

by Startups.Studio

Growth Waitlist

Waitlist.admit

POST /{namespace}/waitlists/{waitlist}/admit

Admit releases Leads from a Waitlist to the Offer they waited for, in the order the Waitlist ranks them.

Noun: Waitlist
Mode: do
Event: Waitlist.admitted

You, to your agent

Admit the latest waitlist.

curl -X POST https://api.sb/tutorloop.com/waitlists/waitlist_1/admit \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"count":1}'

import { $ } from 'startup-builder'

const { leads, waitlist } = await $.Waitlist.admit({ waitlist: 'waitlist_1', count: 1 })

npx startup-builder do Waitlist.admit --json '{"waitlist":"waitlist_1","count":1}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Waitlist.admit({ waitlist: 'waitlist_1', count: 1 })"
  }
}

Inputs

Input	Type	Required	Description
`waitlist`	Waitlist	required	The Waitlist.
`count`	`integer`	required	How many Leads to admit.

Outputs

Output	Type	Required	Description
`leads`	list of Lead	required	The admitted Leads.
`waitlist`	Waitlist	required	The Waitlist after the admitted Leads left it.

Effects

Emits Waitlist.admitted.
Performed by the Sales Lead.

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.	Waitlist.admit
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	Waitlist.admit

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

Waitlist

Previous Page

Waitlist.create

Next Page