URL: /code/apps/sequences/pause · Id: `page:/code/apps/sequences/pause`

# Enrollment.pause

> Holds one person’s run through a Sequence at its current step, without ending it.

POST https://api.sb/{your-domain}/enrollments/{enrollment}/pause

Holds one person’s run through a [Sequence](https://startupbuilder.dev/business/nouns/sequence) at its current step, without ending it.

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

```text title="Run it · Ask"
Maria is out until Monday: pause her first-touch run.
```

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

const result = await $.try.Enrollment.pause({ enrollment: 'https://api.sb/leaseline.app/enrollments/enrollment_Kd5pL9mB2x' })
```

```json title="Run it · Response"
{
  "api": "https://api.sb/leaseline.app",
  "enrollment": {
    "$id": "https://api.sb/leaseline.app/enrollments/enrollment_Kd5pL9mB2x",
    "$type": "Enrollment",
    "status": "paused",
    "step": 2
  },
  "action": {
    "operation": "Enrollment.pause",
    "mode": "try",
    "status": "done"
  }
}
```

Its Inputs, Outputs, Effects and guards quote [the hub’s `Enrollment.pause`](https://startupbuilder.dev/business/nouns/enrollment/pause); 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 [Sequences](/code/apps/sequences#verbs).

## Inputs
| Name | Type | Default | Meaning |
| --- | --- | --- | --- |
| `enrollment` | `Enrollment` | Required | The Enrollment to pause. |

## Outputs
| Field | Type | What `null` means |
| --- | --- | --- |
| `enrollment` | `Enrollment` | Never null: the Enrollment, now `paused`. |

## 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; `Enrollment.paused` 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 Enrollment is saved as the call leaves it, with the Action that changed it.

**Emits**

`Enrollment.paused` with `{ enrollment }`

**Performed by**

[Prospector](https://startupbuilder.dev/agents/sales/prospector)

**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 `Enrollment.paused` delivers the result.

**Ask**

```text
Maria is out until Monday: pause her first-touch run.
```

**API**

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

**CLI**

```bash
npx startup-builder do Enrollment.pause --send --data '{}'
```

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

**MCP**

```json
{
  "name": "do",
  "arguments": {
    "mode": "send",
    "code": "return await $.Enrollment.pause({})"
  }
}
```

**SDK**

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

const result = await $.send.Enrollment.pause({
  enrollment: 'https://api.sb/leaseline.app/enrollments/enrollment_Kd5pL9mB2x',
})
```


```json title="Response, in send mode"
{
  "mode": "send",
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/action_Sd3kQ9vT2w",
    "operation": "Enrollment.pause",
    "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
[`Contact.enroll`](/code/apps/sequences/enroll) · [`Enrollment.resume`](/code/apps/sequences/resume) · [`Enrollment.cancel`](/code/apps/sequences/cancel) · [`Sequence.create`](/code/apps/sequences/create-sequence) · [`Sequence.update`](/code/apps/sequences/update) · [`Funnel.create`](/code/apps/sequences/create-funnel)