Interface: EnrollmentsResource

Defined in: packages/sdk/src/resources/enrollments.ts:13

A contact's membership in a sequence. Enrollments are created by sequences.enroll() or by an event trigger; this resource stops one early.

Example

const { enrollmentId } = await mailroom.sequences.enroll("onboarding", { email: "ada@example.com" });
await mailroom.enrollments.cancel(enrollmentId); // no further steps will send

Methods

cancel()

cancel(id: string, opts?: CallOptions): Promise<{
  id: string;
  status: "cancelled";
}>;

Defined in: packages/sdk/src/resources/enrollments.ts:15

Cancel an active enrollment; remaining steps are never sent.

Parameters

Parameter	Type
id	string
opts?	CallOptions

Returns

Promise<{ id: string; status: "cancelled"; }>