Sign in
latestOpenAPI 3.1.02026-08-171503582.2 MB

6199a9464227

Workflow Revisions

Update a workflow revision

Updates a draft workflow revision. Only revisions in Draft status can be updated. PUT semantics: send all fields; optional fields omitted or set to null are cleared. The checklist name template can include merge tag variables (e.g. {{workflow.name}}). Use the listWorkflowRevisionVariables endpoint to discover available variables. Returns the updated revision.

put/workflows/{workflowId}/revisions/{revisionId}

Path parameters

workflowIdstring required

The ID of the Workflow

revisionIdstring required

The ID of the Revision

Request body

changeType'Material' | 'NonMaterial' required

Whether the changes in this revision are significant. Material — substantial changes; bumps the major version (e.g. 1.3 → 2.0). NonMaterial — minor edits like wording or typo fixes; bumps the minor version (e.g. 1.3 → 1.4).

changeExplanationstring

Optional human-readable explanation of what changed in this revision; surfaced in revision history.

defaultChecklistNamestring

Default name applied to new workflow runs created from this revision when the caller does not provide one. Supports merge tags (e.g. {{form.customer_name}}).

Response

Example response

{
  "data": {
    "id": "iF2H8O21_rPMNj5U8hBJug",
    "createdBy": {
      "id": "naAJxoDIuwdgNsQHGRRGqA",
      "email": "jane.doe@example.com",
      "username": "Jane Doe"
    },
    "updatedBy": {
      "id": "naAJxoDIuwdgNsQHGRRGqA",
      "email": "jane.doe@example.com",
      "username": "Jane Doe"
    },
    "workflowId": "iF2H8O21_rPMNj5U8hBJug"
  },
  "links": [
    {
      "href": "https://api.process.st/api/v1.1/resource/XXX"
    }
  ]
}