Neon API (unofficial showcase)
PATCH/projects/{project_id}/branches/{branch_id}/auth/email_provider

Update email provider configuration

Updates the email provider configuration for a branch's Neon Auth integration. Use the standard fields to configure SMTP settings and the sender identity; Better Auth integrations merge omitted fields, while Legacy Stack Auth integrations require all six standard fields on each update. Returns the updated email provider configuration.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 parameters · 6 body fields
project_idstringrequired
The Neon project identifier. Must contain 1 to 60 lowercase letters, digits, or hyphens.
branch_idstringrequired
The Neon branch identifier. Must contain 1 to 60 lowercase letters, digits, or hyphens.

Email provider configuration. Better Auth integrations merge omitted fields; Legacy Stack Auth integrations require all six standard SMTP and sender fields on every update.

hoststringoptional
Hostname of the email server.
portintegeroptional
TCP port of the SMTP server. Common values: 25 (SMTP), 465 (SMTPS), 587 (submission).
usernamestringoptional
Username for authenticating with the SMTP server.
passwordstringoptional
Password for authenticating with the SMTP server.
sender_emailstringoptional
Email address used as the From address on outgoing auth emails.
sender_namestringoptional
Display name shown as the sender in outgoing emails.

2 status codes
200Returns the updated email provider configuration, including the configured SMTP connection details and sender identity.
hoststringrequired
Hostname of the email server.
portintegerrequired
TCP port of the SMTP server. Common values: 25 (SMTP), 465 (SMTPS), 587 (submission).
usernamestringrequired
Username for authenticating with the SMTP server.
passwordstringrequired
On GET, returned redacted (empty) for ordinary callers, while callers with project-credential read permission receive the stored password — do not assume this field is empty. Update (PATCH) responses always return it redacted (empty) regardless of permission. Provide a value on update to set or rotate the password.
sender_emailstringrequired
Email address used as the From address on outgoing auth emails.
sender_namestringrequired
Display name shown as the sender in outgoing emails.
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.
request_idstringoptional
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.
codestringrequired
Machine-readable code classifying the error type. See `message` for a human-readable explanation.
Default:
messagestringrequired
Error message

Error handling

For Legacy Stack Auth integrations, include host, port, username, password, sender_email, and sender_name in every update; partial standard updates are not supported. Better Auth integrations merge omitted fields, so you can send only the standard fields you want to change. The project_id and branch_id path parameters must each contain 1 to 60 lowercase letters, digits, or hyphens.