Send an email notification to a lead to start or continue a workflow

post

https://api.trulioo.com/wfs/interpreter-v2/end-clients/{endClientId}/notification

Sends an email containing a signed link allowing the recipient to resume the workflow. When the lead status is IN_PROGRESS and the flow has abandonment timer configured, the abandonment timer is reset by default; set resetAbandonmentTimer to false in the request body to suppress this. For NOT_STARTED leads, the timer reset toggle is ignored.

Path Params

endClientId

string

required

EndClient ID

Body Params

recipientEmail

string

The recipient's email address. The notification will be sent to this address.

companyName

string

Name of the requesting company. This will be communicated to your customers. Must be non-blank.

recipientName

string | null

Optional recipient display name used in the email greeting. If omitted, falls back to the name from the submitted data, or a generic greeting if unavailable.

resetAbandonmentTimer

object | null

If true, resets the abandonment timer when the lead is IN_PROGRESS. Has no effect on leads that are NOT_STARTED or lack an abandonment timer. Defaults to true if omitted.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200

Email notification dispatched successfully

401

Invalid token provided

400Invalid request payload or lead status not eligible for email notification

403Forbidden

404End client or eligible flow not found

500Internal server error

502Email dispatch failed (integration service error)