Workflows
Update a scheduled trigger
Change a cron or one-shot trigger’s schedule, backfill policy, inputs or enabled flag.
PATCH
Update a scheduled trigger
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.
v2 compatibility notes
PATCH /api/v2/workflows/updateTrigger changes a cron or one-shot trigger’s schedule, backfill policy, inputs or enabled flag.
Authentication
External App credential or platform API key, or a Personal key. Requires permissionworkflows:manage (an elevated permission) held at the trigger’s orgUnitId and at the platform scope, as the Console decides it; otherwise 403, recorded, and nothing is written. Forge agents can never hold workflows:manage. Because the success returns what was written, the credential’s scopes must include workflows:read as well; otherwise 403 naming workflows:read. A trigger the caller may not read (workflows:read at its workflow’s home and at its orgUnitId) answers 404, as a missing one does. A Personal key acts as its owner; an External App or platform key acts as itself. The change is audited with that actor and, for an app or platform key, who granted it.
Body
{id, cronExpression?, timezone?, oneShotFireAt?, backfillPolicy?, enabled?, inputs?}, with at least one field besides id. A change other than disabling re-runs the version entitlement decision. A files_ id in inputs needs files:read (otherwise 403) and must name a file the caller could download at the request’s org unit, as at a dispatch (otherwise 422): a scheduled fire launches with the stored inputs, so they are decided when written. An ingress or email trigger answers 409: change it with updateIngressConfig or its email route.
Version entitlement
A trigger runs a published version, so the version’s agents and bound companies are decided for the caller as at a publish:agents:use and credentials:use, each reached by its own scope. A refusal is 422 naming the gate’s code, and nothing is written.
Who a trigger belongs to
A Personal key’s trigger belongs to its owner’s worker seat and keeps firing after the key expires; a key whose owner has no active seat answers422. An External App’s or platform key’s trigger belongs to the app or key, and stops (paused, audited) when the app or key loses workflows:manage. Editing a trigger never changes who it belongs to.
Idempotency
Send anIdempotency-Key to make a retry safe: a same-key retry within 24 hours returns the recorded result only while the caller may still read the trigger and holds workflows:manage at its org unit and the platform scope; otherwise 409 idempotency_result_unavailable, and the write never runs twice (see Idempotency).
Responses
data is {trigger, ingress}. trigger has the fields described in getTrigger; ingress is null for a cron or one-shot trigger, and otherwise the ingress configuration: status, tokenPrefix (for display only), inputMode, wrapKey, dedupeHeader, ratePerMinute, verification (mode, header and scheme, never the secret) and customerAttributionConfigured. The owner, creator, stored inputs, token and token hash are never returned.
Errors
Example
Authorizations
Headers
Body
application/json

