Send test email using the saved email provider

POST/projects/{project_id}/branches/{branch_id}/auth/email_provider/testSend 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.

Parameters

project_idstringpathrequired

The Neon project ID

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

branch_idstringpathrequired

The Neon branch ID

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

Request body

required

application/json

objectSendNeonAuthEmailProviderTestRequest

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

recipient_emailstring · emailrequired

The email address to send the test email to.

maxLength 256 · minLength 1

Example request

{
  "recipient_email": "user@example.com"
}

Responses

objectSendNeonAuthTestEmailResponse

error_messagestring

The error message from the email server.

successbooleanrequired

Whether the test email was sent successfully.

Example response

{
  "error_message": "string",
  "success": true
}

defaultGeneral Error. The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received. - If no response is returned from the API, a network error or timeout likely occurred. - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results. The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**. The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout. Any request that returns a `503 Service Unavailable` response is always safe to retry. Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress. application/json

objectGeneralError

codestringrequired

default ""

messagestringrequired

Error message

request_idstring

Unique identifier for the request, useful for debugging. You can set this value manually by including an `X-Request-ID` header in the request. If not provided, the value will be generated automatically.

Example response

{
  "code": "",
  "message": "string",
  "request_id": "string"
}

Examples

project_idrequiredpath parameter

branch_idrequiredpath parameter

curl -X POST 'https://console.neon.tech/api/v2/projects/string/branches/string/auth/email_provider/test' \
  -H 'Content-Type: application/json' \
  -d '{"recipient_email":"user@example.com"}'

const response = await fetch('https://console.neon.tech/api/v2/projects/string/branches/string/auth/email_provider/test', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"recipient_email":"user@example.com"}),
});
const data = await response.json();

const response = await fetch('https://console.neon.tech/api/v2/projects/string/branches/string/auth/email_provider/test', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"recipient_email\":\"user@example.com\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "https://console.neon.tech/api/v2/projects/string/branches/string/auth/email_provider/test",
    headers={"Content-Type": "application/json"},
    data='{"recipient_email":"user@example.com"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"recipient_email":"user@example.com"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "https://console.neon.tech/api/v2/projects/string/branches/string/auth/email_provider/test", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://console.neon.tech/api/v2/projects/string/branches/string/auth/email_provider/test");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"recipient_email\":\"user@example.com\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://console.neon.tech/api/v2/projects/string/branches/string/auth/email_provider/test"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"recipient_email\":\"user@example.com\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://console.neon.tech/api/v2/projects/string/branches/string/auth/email_provider/test")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"recipient_email\":\"user@example.com\"}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://console.neon.tech/api/v2/projects/string/branches/string/auth/email_provider/test");
request.Content = new StringContent("{\"recipient_email\":\"user@example.com\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "error_message": "string",
  "success": true
}

{
  "code": "",
  "message": "string",
  "request_id": "string"
}