Send test email using the saved email provider

Sends a test email using the branch's already-saved custom SMTP configuration. Only the
recipient_email is provided — the stored SMTP settings and password are used server-side,
so the caller does not need to re-supply (or be able to read) the password. This avoids the
GET response's masked password being sent back, which would fail SMTP authentication.

Requires a configured custom SMTP provider on a Better Auth integration. A shared provider,
a missing configuration, or a non-Better-Auth integration is rejected.

Path Params
string
required
^[a-z0-9-]{1,60}$

The Neon project ID

string
required
^[a-z0-9-]{1,60}$

The Neon branch ID

Body Params

Request to test the branch's saved email provider. Only the recipient is supplied; the stored
SMTP settings and password are used server-side.

string
required
length between 1 and 256

The email address to send the test email to.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json