Neon API (unofficial showcase)
PATCH/projects/{project_id}/branches/{branch_id}/triggers/{trigger_id}

Update a branch trigger

Updates a branch trigger using a partial configuration. Set type to the existing trigger kind and provide at least one other field to change; supported kinds are schedule and storage_object_created. Editing an inherited trigger creates a child-local shadow that remains disabled unless you explicitly enable it; disabling a trigger does not cancel occurrences already committed for delivery.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

3 parameters · 6 body fields
project_idstringrequired
The Neon project ID. Must contain 1–60 lowercase letters, numbers, or hyphens.
branch_idstringrequired
The Neon branch ID. Must contain 1–60 lowercase letters, numbers, or hyphens.
trigger_idstringrequired
The opaque, project-wide trigger ID. Must be 1–128 characters, start with a letter or number, and contain only letters, numbers, underscores, periods, or hyphens.

Partial trigger configuration update. Set type to the existing trigger kind and provide at least one other field to update.

typestringrequired
Trigger type discriminator; it does not change the trigger type.
Allowed:schedule
function_slugstringoptional
Replacement branch-local Function slug.
namestringoptional
function_pathstringoptional
scheduleobjectoptional
A numeric five-field cron schedule interpreted in UTC.
enabledbooleanoptional
True enables and false disables future scheduling.

2 status codes
200Returns the updated branch-effective trigger configuration.
triggerobjectrequired
A branch-effective trigger discriminated by `type`. The supported trigger types are `schedule` and `storage_object_created`.
defaultGeneral 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_idstringoptional
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.
codestringrequired
Machine-readable code classifying the error type. See `message` for a human-readable explanation.
Default:
messagestringrequired
Error message

Error handling

The project_id path parameter and branch_id path parameter must each contain 1–60 lowercase letters, numbers, or hyphens; the trigger_id path parameter must be 1–128 characters and start with a letter or number. Set type to match the existing trigger and provide at least one other field; type must be schedule or storage_object_created.