Sign in
Auth

Update phone number plugin configuration

Updates the phone number plugin configuration for Neon Auth. Only the fields provided in the request body are updated; omitted fields retain their current values. The phone number plugin enables phone-based OTP authentication. OTP codes are delivered via the send.otp webhook event with delivery_preference: "sms". A webhook must be configured with the send.otp event enabled for SMS delivery to work.

patch/projects/{project_id}/branches/{branch_id}/auth/plugins/phone-number

Request

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

Request body

enabledboolean

Whether the phone number plugin is enabled.

otp_expires_ininteger

Time in seconds before the OTP expires

Response

The phone number plugin configuration has been updated

enabledboolean required

Whether the phone number plugin is enabled.

otp_expires_ininteger

Time in seconds before the OTP expires

Changes

No recorded changes to this operation across all 15 revisions of this API.