Skip to main content
POST
Start Email Sign-In

Path Parameters

client_id
integer
required

Client ID for the email sign-in flow

program_id
integer
required

Program ID for the email sign-in flow

session_id
string
required

Session ID for the email sign-in flow (optional)

Body

application/json

Email address for email sign-in

email
string<email>
required
donor_id
integer | null

Optional donor ID when a donor has already been selected

passwordless_mode
enum<string> | null

Requested email sign-in delivery mode

Available options:
magic_link,
verification_code

Response

Sign-in instructions sent successfully or a donor selection is required

status
string

success when the email sign-in flow continues, or selection_required when multiple donor accounts match the email.

Example:

"success"

message
string
donor
object | null

Returned for auto-resolved single-donor email sign-ins so the frontend can offer verification-code fallback.

donors
object[]

Returned when a donor selection is required before sending the sign-in email.