/projects/{project_id}/auth/email_serverdeprecatedThis endpoint is deprecated. Scheduled for removal on 2026-03-01.
Update email server configuration
DEPRECATED, use /projects/{project_id}/branches/{branch_id}/auth/email_provider instead. Updates the email server configuration for the specified project.
Quick start
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/auth/email_server" \
-X PATCH \
-H "Authorization: Bearer $NEON_API_KEY"import { createNeonClient, raw } from '@neon/sdk';
const neon = createNeonClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await raw.updateNeonAuthEmailServer({
client: neon.client,
path: {
project_id: process.env.PROJECT_ID
}
});Parameters
project_idThe Neon project ID
Request body
6 required Required: host, port, username, password, sender_email, sender_name.
hostportusernamepasswordsender_emailsender_nameResponse
200The OAuth provider has been added to the project
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.