Skip to content

by Startups.Studio

Growth Enrollment

Enrollment.pause

POST /{namespace}/enrollments/{enrollment}/pause

Pause stops one Contact’s run through a Sequence at its current step, without ending it.

Noun: Enrollment
Mode: do
Event: Enrollment.paused

You, to your agent

Pause the latest enrollment.

curl -X POST https://api.sb/kilnbakery.com/enrollments/enrollment_1/pause \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const enrollment = await $.Enrollment.pause({ enrollment: 'enrollment_1' })

npx startup-builder do Enrollment.pause --json '{"enrollment":"enrollment_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Enrollment.pause({ enrollment: 'enrollment_1' })"
  }
}

Pause stops one person’s run through a Sequence at the step they are on, without ending it.

Inputs

Input	Type	Required	Description
`enrollment`	Enrollment	required	The Enrollment to pause.

Outputs

Output	Type	Required	Description
`enrollment`	Enrollment	required	The Enrollment, now `paused`.

Effects

Emits Enrollment.paused.
Performed by the Prospector.
Two-way: it runs at once, in the try, send and do modes.

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.	Enrollment.pause

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

Enrollment.list

Previous Page

Enrollment.resume

Next Page