Sign in
Auth

Update email provider configuration

Changed on

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.

patch/projects/{project_id}/branches/{branch_id}/auth/email_provider

Request

  • Base URL: https://console.neon.tech/api/v2
  • URL: https://console.neon.tech/api/v2/projects/{project_id}/branches/{branch_id}/auth/email_provider
  • Auth: one of:
    • HTTP bearer
    • API key in cookie zenith
    • API key in cookie keycloak_token

Request body

OR

Response

The email provider configuration has been updated

OR

Changes

  • d0a798a3e907Revision changes
    • ▲

      added to the response body oneOf list for the response status

    • ○

      the request property //// became optional

    • ○

      the request property //// became optional

    • ○

      the request property //// became optional

    • ○

      the request property //// became optional

    • ○

      the request property //// became optional

    • ○

      the request property //// became optional

    • ○

      mapped value for key standard changed from to from the response discriminator for the response status

    • ○

      removed from the response body oneOf list for the response status