---
title: "Update phone number plugin configuration"
method: PATCH
path: "/projects/{project_id}/branches/{branch_id}/auth/plugins/phone-number"
tags: ["Auth"]
---

# Update phone number plugin configuration

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

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.

## Request body

- NeonAuthPhoneNumberConfigUpdate
  - `enabled` boolean — Whether the phone number plugin is enabled
  - `otp_expires_in` integer — Time in seconds before the OTP expires

## Response `200`

The phone number plugin configuration has been updated

- NeonAuthPhoneNumberConfig
  - `enabled` boolean, required — Whether the phone number plugin is enabled
  - `otp_expires_in` integer — Time in seconds before the OTP expires

## Other responses

- `default` — General 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.

---

[API](https://skmtc.dev/neon/apis/neon-api.md) · [All operations](https://skmtc.dev/neon/apis/neon-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/neon/neon-api/revisions/cfde79a5c713/schema)