URL: /code/apps/forms-and-waitlists/admit · Id: `page:/code/apps/forms-and-waitlists/admit`

# Waitlist.admit

> Lets leads in from a Waitlist to the offer they waited for, in the order the Waitlist ranks them.

POST https://api.sb/{your-domain}/waitlists/{waitlist}/admit

Lets [leads](https://startupbuilder.dev/business/nouns/lead) in from a [Waitlist](https://startupbuilder.dev/business/nouns/waitlist) to the [offer](https://startupbuilder.dev/business/nouns/offer) they waited for, in the order the Waitlist ranks them.

- **Action class:** None
- **Approval:** Runs on its own
- **Emits:** `Waitlist.admitted`
- **Price:** Free

```text title="Run it · Ask"
Let the first 10 on the owner-statements waitlist in.
```

```ts title="Run it · SDK"
import { $ } from 'startup-builder'

const result = await $.try.Waitlist.admit({ waitlist: 'https://api.sb/leaseline.app/waitlists/waitlist_Gm7hJ3kL6a', count: 10 })
```

```json title="Run it · Response"
{
  "api": "https://api.sb/leaseline.app",
  "waitlist": {
    "$id": "https://api.sb/leaseline.app/waitlists/waitlist_Gm7hJ3kL6a",
    "$type": "Waitlist",
    "size": 28
  },
  "leads": {
    "count": 10
  },
  "action": {
    "operation": "Waitlist.admit",
    "mode": "try",
    "status": "done"
  }
}
```

Its Inputs, Outputs, Effects and guards quote [the hub’s `Waitlist.admit`](https://startupbuilder.dev/business/nouns/waitlist/admit); this page adds what each Venue honors, its limits and a worked call. It is one of the [Verbs](https://startupbuilder.dev/business/nouns/verb) of [Forms and waitlists](/code/apps/forms-and-waitlists#verbs).

## Inputs
| Name | Type | Default | Meaning |
| --- | --- | --- | --- |
| `waitlist` | `Waitlist` | Required | The Waitlist. |
| `count` | `integer` | Required | How many leads to admit. |

## Outputs
| Field | Type | What `null` means |
| --- | --- | --- |
| `leads` | `Lead[]` | Never null: the admitted leads. |
| `waitlist` | `Waitlist` | Never null: the Waitlist after the admitted leads left it. |

## Effects
**Action class**

None: no approval rule names it, so it runs within its seat’s Permissions and Limits

**Modes**

- `try`: Runs every check and returns the record as it would be; nothing is stored.
- `send`: Returns a pending Action at once; `Waitlist.admitted` fires when it is done.
- `do`: Waits for the Action to finish and returns the record.

**Idempotency**

Only with a key: the same `Idempotency-Key` and input return the first Action, and the same key with other input returns `409`.

**Saved or shared**

The Waitlist is saved as the call leaves it, with the Action that changed it.

**Emits**

`Waitlist.admitted` with `{ waitlist }`

**Performed by**

Whichever seat calls it

**Price**

Free on your own account: the platform charges nothing for the call.

## On each Venue
It acts on your own records and reaches no Venue, so every account answers the same way.

## What try does
Runs every check the call meets and returns the record as it would be; nothing is stored, sent or posted.

## Refuses when
The hub sets no guard of its own on this call: it refuses only on the shared checks every write meets (a missing record, a Permission the seat lacks).

## When it waits
Returns in one response; nothing waits.

## Example
In `send` mode the call returns its pending Action at once, and `Waitlist.admitted` delivers the result.

**Ask**

```text
Let the first 10 on the owner-statements waitlist in.
```

**API**

```bash
curl -X POST "https://api.sb/leaseline.app/waitlists/waitlist_Gm7hJ3kL6a/admit?mode=send" \
  -H "Authorization: Bearer $SB_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "count": 10
}'
```

**CLI**

```bash
npx startup-builder do Waitlist.admit --send --data '{
  "count": 10
}'
```

`--send` returns the pending Action at once.

**MCP**

```json
{
  "name": "do",
  "arguments": {
    "mode": "send",
    "code": "return await $.Waitlist.admit({ count: 10 })"
  }
}
```

**SDK**

```ts
import { $ } from 'startup-builder'

const result = await $.send.Waitlist.admit({
  waitlist: 'https://api.sb/leaseline.app/waitlists/waitlist_Gm7hJ3kL6a',
  count: 10,
})
```


```json title="Response, in send mode"
{
  "mode": "send",
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/action_Sd3kQ9vT2w",
    "operation": "Waitlist.admit",
    "status": "pending",
    "reason": "running"
  }
}
```

To retry, send the same `Idempotency-Key`: the retry returns the first answer for $0. A new key reads again.

## Used by
None.

## Related
[`Waitlist.join`](/code/apps/forms-and-waitlists/join) · [`Visitor.identify`](/code/apps/forms-and-waitlists/identify) · [`Visitor.merge`](/code/apps/forms-and-waitlists/merge) · [`Form.create`](/code/apps/forms-and-waitlists/create) · [`Form.update`](/code/apps/forms-and-waitlists/update)