/projects/{project_id}/branches/{branch_id}/functions/{slug}betaUpdate a function
Updates the function's mutable metadata — currently only the display
name. A string sets the display name; null clears it, after which
the function's name falls back to its slug. Leading and trailing
whitespace is trimmed; a whitespace-only name is rejected. Acts only
on a function owned by the branch: a slug that is only inherited from
an ancestor branch returns 404 — rename it on the branch that owns
it. Like every other change on a branch, a rename is isolated per
branch: a branch forked before the rename keeps the name it had at
fork time.
Note: This endpoint is currently in Private Beta.
Quick start
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/functions/$SLUG" \
-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.updateProjectBranchFunction(process.env.PROJECT_ID, process.env.BRANCH_ID, process.env.SLUG);Parameters
project_idThe Neon project ID
branch_idThe Neon branch ID
slugThe function slug
Request body
1 required Required: name.
nameNew display name for the function. null clears the display
name; the function's name then falls back to its slug. Leading
and trailing whitespace is trimmed; a whitespace-only name is
rejected.
≥1 chars, ≤256 chars
Response
200The updated function
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.