Enrollment methods: cancel, pause, resume

Reference for Enrollment, one group of Enrollment methods.

Enrollment.cancel

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

TypeScript

interface EnrollmentVerbs {
  cancel(input: EnrollmentCancelInput, options?: SB.CallOptions): SB.Call<Enrollment>
}

Inputs

Input	Type	Required	Description
`enrollment`	Enrollment	required	The Enrollment to end.
`reason`	`string`	required	Why it ends.

Returns

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

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

Example

TypeScript

import { $ } from 'startup-builder'

const enrollment = await $.Enrollment.cancel({ enrollment: 'enrollment_t2LKaLorKn', reason: 'replied' })

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

TypeScript

interface EnrollmentVerbs {
  pause(input: EnrollmentPauseInput, options?: SB.CallOptions): SB.Call<Enrollment>
}

Inputs

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

Returns

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

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

Example

TypeScript

import { $ } from 'startup-builder'

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

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

TypeScript

interface EnrollmentVerbs {
  resume(input: EnrollmentResumeInput, options?: SB.CallOptions): SB.Call<Enrollment>
}

Inputs

Input	Type	Required	Description
`enrollment`	Enrollment	required	The paused Enrollment.

Returns

Output	Type	Required	Description
`enrollment`	Enrollment	required	The Enrollment, `active` again.

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

Example

TypeScript

import { $ } from 'startup-builder'

const enrollment = await $.Enrollment.resume({ enrollment: 'enrollment_t2LKaLorKn' })