/projects/{project_id}/branches/{branch_id}/auth/email_providerUpdate email provider configuration
Updates the email provider configuration for the specified branch's Neon Auth integration. The email provider handles transactional messages such as verification emails and password reset links.
Partial standard updates — omitting fields to keep their stored values — are supported only for
Better Auth integrations, which merge omitted fields server-side. Legacy Stack Auth integrations do
not merge and require all six standard fields (host, port, username, password,
sender_email, sender_name) on every update; a partial standard body is rejected with 400.
Quick start
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/auth/email_provider" \
-X PATCH \
-H "Authorization: Bearer $NEON_API_KEY"neon neon-auth config email-provider update --type <type>Parameters
project_idThe Neon project ID
branch_idThe Neon branch ID
Request body
No field is required.
hostHostname of the email server.
portTCP port of the SMTP server. Common values: 25 (SMTP), 465 (SMTPS), 587 (submission).
usernameUsername for authenticating with the SMTP server.
passwordPassword for authenticating with the SMTP server.
sender_emailEmail address used as the From address on outgoing auth emails.
sender_nameDisplay name shown as the sender in outgoing emails.
Response
200The email provider configuration has been updated
Alternative shape: set type: shared to use the shared variant (all fields optional).
Errors
General error
This endpoint can return the standard Neon API error response.
Response fields
messageRequired. Human-readable error message.codeRequired. Machine-readable error code.request_idOptional. Request identifier for debugging. You can provide one with theX-Request-IDheader.
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.








