/projects/{project_id}/branches/{branch_id}/triggers/{trigger_id}betaUpdate a trigger
Applies a partial update. The required type discriminator must identify
the existing trigger kind. The supported types are schedule and
storage_object_created. Editing an inherited trigger creates a
child-local shadow with the same trigger_id; it remains disabled unless
this request explicitly enables it. For a schedule trigger, updating the
schedule or enabled state increments version and recomputes
next_run_at.
Disabling stops future scheduling but does not cancel occurrences already
committed for delivery. For storage_object_created, the configuration
selects one exact bucket. An omitted object-key prefix matches every key
in that bucket; a present prefix is matched byte-for-byte and
case-sensitively against the full key, without path normalization or a
path-segment boundary.
Note: This endpoint is currently in Beta.
Quick start
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/triggers/$TRIGGER_ID" \
-X PATCH \
-H "Authorization: Bearer $NEON_API_KEY"import { createNeonClient, raw } from '@neon/sdk';
const neon = createNeonClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await raw.updateProjectBranchTrigger({
client: neon.client,
path: {
project_id: process.env.PROJECT_ID,
branch_id: process.env.BRANCH_ID,
trigger_id: process.env.TRIGGER_ID
}
});Parameters
project_idThe Neon project ID
branch_idThe Neon branch ID
trigger_idThe opaque, project-wide trigger ID
Request body
1 required Required: type.
typeTrigger type discriminator; it does not change the trigger type.
name≥1 chars, ≤256 chars
function_slugReplacement branch-local Function slug.
function_path≥1 chars, ≤2048 chars
scheduleA numeric five-field cron schedule interpreted in UTC.
enabledTrue enables and false disables future scheduling.
Response
200The updated trigger
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.