Sign in
Workflows

Patch a workflow definition (create/update/delete nodes)

patch/api/workflows/{id}

Path parameters

idstring required

Request body

deletestring[]

Node IDs to delete

onNodeFailure'fail' | 'continue'

Update the definition-level onNodeFailure behavior

triggerSchemaobject nullable

Optional JSON-Schema describing the expected trigger payload shape. Pass an object to set/replace; pass null to clear; omit to leave unchanged. Validator subset: type, required, properties, enum, const, items. Other JSON-Schema keywords are silently ignored.

keystring

Non-unique asset directory namespace (for example shared/ or personal/<user-id>/drafts/). Runtime write boundaries normalize and validate the canonical form.

Response

Workflow patched (version snapshot created)

idstring uuid required
keystring required

Non-unique asset directory namespace (for example shared/ or personal/<user-id>/drafts/). Runtime write boundaries normalize and validate the canonical form.

namestring required
descriptionstring
enabledboolean required
inputobject
triggerSchemaobject
dirstring
vcsRepostring
createdByAgentIdstring
createdAtstring required
lastUpdatedAtstring required
createdBystring
updatedBystring
favoriteboolean

Changes

Changed in 3 of the 104 revisions of this API.274

  • 06cac6a7c5bc263See the full diff
    • ▲

      added subschema #2 to the request body allOf list

      request-body-all-of-added

    • ▲

      the request's body type changed from object to no type

      request-body-type-changed

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the request property

      request-property-removed

    • ○

      added the media type application/json for the response with the status

      response-media-type-added

    • ○

      added the media type application/json for the response with the status

      response-media-type-added

    • ○

      added the media type application/json for the response with the status

      response-media-type-added

  • f1022d5edb0d1See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

  • 0c910612f9ac1See the full diff
    • ●

      removed the request property

      request-property-removed