/projects/{project_id}/branches/{branch_id}/auth/plugins/phone-numberUpdate 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.
Quick start
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/auth/plugins/phone-number" \
-X PATCH \
-H "Authorization: Bearer $NEON_API_KEY"import { createApiClient } from '@neondatabase/api-client';
const api = createApiClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await api.updateNeonAuthPhoneNumberPlugin(process.env.PROJECT_ID, process.env.BRANCH_ID);Parameters
project_idThe Neon project ID
branch_idThe Neon branch ID
Request body
No field is required.
enabledWhether the phone number plugin is enabled
otp_expires_inTime in seconds before the OTP expires
min: 60, max: 600
Response
200The phone number plugin configuration has been updated
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.