Skip to main content

Why one contact was not enrolled. Contacts absent from the dictionary were enrolled and appear in added.

error
enum<string>

Always invalidInput on this endpoint — every refusal is reported per contact rather than as a request-level failure. Use reason to tell the refusals apart.

Available options:
invalidInput
errorDetails
string | null

Readable statement of the same refusal, for surfacing to a person. Its wording can change; branch on reason.

reason
enum<string>

Stable code naming why this contact was refused.

Available options:
contactOptedOut,
contactNotFound,
contactAlreadyInSequence,
skippedByOwner,
stepNotReachable,
batchLimitExceeded,
reEnrollmentBouncedOnPreviousPass,
reEnrollmentInCooldown,
reEnrollmentBlacklisted,
unknown