Send test email

POST /projects/{project_id}/branches/{branch_id}/auth/send_test_emailbetadeprecated

This endpoint is deprecated. Scheduled for removal on 2027-02-28.

Sends a test email using the SMTP server settings supplied in the request body to verify connectivity and credentials. The request body must include the full SMTP server settings (host, port, username, password, sender_email, sender_name) and the recipient_email address.

Deprecated: to test a branch's already-saved configuration, use sendNeonAuthEmailProviderTest, which reuses the stored SMTP password server-side so the caller never has to re-supply (or be able to read) it. This endpoint remains available for testing an unsaved full configuration and for non-Better-Auth providers.

Markdown for AI context

curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/auth/send_test_email" \
  -X POST \
  -H "Authorization: Bearer $NEON_API_KEY"

Also available in

neon neon-auth config email-provider test --recipient-email <recipient-email>

Project ID

project_id

string

The Neon project ID

Branch ID

branch_id

string

The Neon branch ID

7 required Required: host, port, username, password, sender_email, sender_name, recipient_email.

Host

host

string

Hostname of the email server.

Port

port

integer

TCP port of the SMTP server. Common values: 25 (SMTP), 465 (SMTPS), 587 (submission).

Username

username

string

Username for authenticating with the SMTP server.

Password

password

string

Password for authenticating with the SMTP server.

Sender email

sender_email

string

Email address used as the From address on outgoing auth emails.

Sender name

sender_name

string

Display name shown as the sender in outgoing emails.

Recipient email

recipient_email

string

The email address to send the test email to.

≥1 chars, ≤256 chars

200

Response with the result of the test email send

"success": (boolean),req

"error_message": (string),

default

General error

This endpoint can return the standard Neon API error response.

Response fields

• message Required. Human-readable error message.
• code Required. Machine-readable error code.
• request_id Optional. Request identifier for debugging. You can provide one with the X-Request-ID header.

Retry guidance

If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.

Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.

Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.