Skip to content

by Startups.Studio

Growth Waitlist

Waitlist.join

POST /{namespace}/waitlists/{waitlist}/join

Join adds a Lead to a Waitlist for an Offer that is not open to them.

Noun: Waitlist
Mode: do
Event: Waitlist.joined

You, to your agent

Join the latest waitlist.

curl -X POST https://api.sb/shiftnote.app/waitlists/waitlist_1/join \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"daniel@shiftnote.app"}'

import { $ } from 'startup-builder'

const { lead, waitlist } = await $.Waitlist.join({ waitlist: 'waitlist_1', email: 'daniel@shiftnote.app' })

npx startup-builder do Waitlist.join --json '{"waitlist":"waitlist_1","email":"daniel@shiftnote.app"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Waitlist.join({ waitlist: 'waitlist_1', email: 'daniel@shiftnote.app' })"
  }
}

Inputs

Input	Type	Required	Description
`waitlist`	Waitlist	required	The Waitlist to join.
`email`	`email`	required	Where to reach the Lead.

Outputs

Output	Type	Required	Description
`lead`	Lead	required	The waiting Lead.
`waitlist`	Waitlist	required	The Waitlist joined.

Effects

Emits Waitlist.joined.
Performed by the Marketing Lead.

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.	Waitlist.join
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.join

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

Previous Page

Waitlist.list

Next Page