Update a trigger

API Reference / Functions / Update 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.

• project_id (string, path, required) The Neon project ID
• branch_id (string, path, required) The Neon branch ID
• trigger_id (string, path, required) The opaque, project-wide trigger ID

• type (string, required) Trigger type discriminator; it does not change the trigger type. Possible values: schedule
• function_slug (string, optional) Replacement branch-local Function slug.
• name (string, optional)
• function_path (string, optional)
• schedule (object, optional) A numeric five-field cron schedule interpreted in UTC.
  • cron (string, required) Numeric five-field cron expression (minute through day-of-week), interpreted in UTC.
• enabled (boolean, optional) True enables and false disables future scheduling.

• trigger (object, optional) A branch-effective trigger discriminated by type. The supported trigger types are schedule and storage_object_created.

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
  }
});

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.

• request_id (string, optional) Unique identifier for the request, useful for debugging. You can set this value manually by including an X-Request-ID header in the request. If not provided, the value will be generated automatically.

• code (string, required) Machine-readable code classifying the error type. See message for a human-readable explanation. Default: ``

• message (string, required) Error message