Sign in

v1

latestOpenAPI 3.0.12026-07-2474233379.5 KB
EndClient API

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

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.

post/end-clients/{endClientId}/notification

Path parameters

endClientIdstring required

EndClient ID

Request body

recipientEmailstring

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

companyNamestring

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

recipientNamestring nullable

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.

resetAbandonmentTimerobject nullable

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.

Example request

{
  "recipientEmail": "john.doe@trulioo.com",
  "companyName": "ABC Limited.",
  "recipientName": "John Doe"
}

Response

Email notification dispatched successfully