Skip to main content

Enrollment totals for the request, so a large import can be checked without walking every item. Present only when the request carried options.sequenceId.

enrolled
integer

Number of imported contacts now running in the sequence.

notEnrolled
integer

Number of imported contacts the sequence did not take.

notEnrolledByReason
Sequence Contact Not Processed Reason Group · object[]

How many contacts each refusal reason accounts for. Covers every contact counted in notEnrolled, unless error is set — the enrollment never ran then, so no contact has a reason of its own and this list is empty.

error
enum<string> | null

Set only when the enrollment never ran, which leaves every imported contact out of the sequence. The contacts themselves are still imported, and their items report it individually.

Available options:
sequenceNotFound,
noStepsInSequence,
forbidden,
internalError
errorDetails
string | null

Readable statement of the same failure. Its wording can change; branch on error.