Skip to content

by Startups.Studio

Growth Enrollment

Enrollment.create

POST /{namespace}/enrollments

Creates an Enrollment.

Noun: Enrollment
Mode: do
Event: Enrollment.created

You, to your agent

Add an enrollment to Kiln Bakery.

curl -X POST https://api.sb/kilnbakery.com/enrollments \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"step":"Example step"}'

import { $ } from 'startup-builder'

const enrollment = await $.Enrollment.create({ step: 'Example step' })

npx startup-builder do Enrollment.create --json '{"step":"Example step"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Enrollment.create({ step: 'Example step' })"
  }
}

Create makes a new Enrollment from the inputs below. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`step`	`string`	required	The Sequence step the person is on.
`nextAt`	`datetime`		When the next step fires; empty while paused or exited.
`branches`	`string[]`		The branches taken so far, in order.
`exitReason`	`string`		Why the run ended.
`contact`	Contact		The Contact this run belongs to; pausing one Contact’s nurture pauses this Enrollment.
`sequence`	Sequence		The Sequence whose steps this Enrollment walks, one step at a time.

Outputs

Output	Type	Required	Description
`enrollment`	Enrollment	required	The Enrollment.

Effects

Emits Enrollment.created.
Two-way: try, send, do.

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

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

Previous Page

Enrollment.delete

Next Page