Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIGrowthEnrollment

Enrollment routes: cancel, pause, resume

The Enrollment Verbs cancel, pause, resume as api.sb routes, with inputs, result, refusals and an example.

Reference for Enrollment, one group of Enrollment routes.

Enrollment.cancel

Cancel ends one Contact’s run through a Sequence for good, with the reason it records as exitReason. Verb page.

Text
POST /{namespace}/enrollments/{enrollment}/cancel

Path: enrollment. Body, as JSON: the other inputs. Emits Enrollment.canceled.

Inputs

InputTypeRequiredDescription
enrollmentEnrollmentrequiredThe Enrollment to end.
reasonstringrequiredWhy it ends.

Returns

OutputTypeRequiredDescription
enrollmentEnrollmentrequiredThe Enrollment, now exited.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/enrollments/enrollment_t2LKaLorKn/cancel \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"replied"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "enrollment": {
    "$id": "https://api.sb/leaseline.app/enrollments/enrollment_t2LKaLorKn",
    "$type": "Enrollment",
    "status": "active",
    "step": "Example step"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Enrollment.cancel",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Enrollment.pause

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

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

Path: enrollment. Emits Enrollment.paused.

Inputs

InputTypeRequiredDescription
enrollmentEnrollmentrequiredThe Enrollment to pause.

Returns

OutputTypeRequiredDescription
enrollmentEnrollmentrequiredThe Enrollment, now paused.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/enrollments/enrollment_t2LKaLorKn/pause \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "enrollment": {
    "$id": "https://api.sb/leaseline.app/enrollments/enrollment_t2LKaLorKn",
    "$type": "Enrollment",
    "status": "active",
    "step": "Example step"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Enrollment.pause",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Enrollment.resume

Resume restarts a paused run at the step it stopped on and sets when that step fires. Verb page.

Text
POST /{namespace}/enrollments/{enrollment}/resume

Path: enrollment. Emits Enrollment.resumed.

Inputs

InputTypeRequiredDescription
enrollmentEnrollmentrequiredThe paused Enrollment.

Returns

OutputTypeRequiredDescription
enrollmentEnrollmentrequiredThe Enrollment, active again.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/enrollments/enrollment_t2LKaLorKn/resume \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "enrollment": {
    "$id": "https://api.sb/leaseline.app/enrollments/enrollment_t2LKaLorKn",
    "$type": "Enrollment",
    "status": "active",
    "step": "Example step"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Enrollment.resume",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

update, delete

Previous

Experiment

Next