Sign in
latestOpenAPI 3.1.02026-08-171503582.2 MB

6199a9464227

Workflows

Update a workflow

Updates all properties of a workflow. All fields are required (PUT semantics).

💡 Notes for MCP clients:

  • Don't default shareLevel to Overview/View/Run or runLinkShareLevel to Public. Only set them when the user explicitly asks for a shareable or public link.

Returns the updated workflow.

put/workflows/{workflowId}

Path parameters

workflowIdstring required

The ID of the Workflow

Request body

namestring required

Display name.

descriptionstring

Optional free-form description of the workflow.

folderIdstring required

The ID of the Folder

shareLevel'None' | 'Overview' | 'View' | 'Run' required

Controls who can access this workflow. None — only organization members can view and run this workflow (when permitted). Overview — used only for Forms; viewers see the form name and background image but not the content. View — anyone with the link can view this workflow. Run — anyone with the link can view and run this workflow. Setting this to any value other than None may return 403 Forbidden ("too new") — anti-spam protection blocks organizations without an eligible paid subscription outright, and blocks startup-plan organizations younger than 7 days.

runLinkShareLevel'Organization' | 'Public' required

Controls who can run this workflow via a run link. Organization — only authenticated organization members with run permission can use the run link. Public — anyone with the link can run the workflow without a Process Street account; all runs created from a public link are automatically shared. Setting this to Public may return 403 Forbidden ("too new") — anti-spam protection blocks organizations without an eligible paid subscription outright, and blocks startup-plan organizations younger than 7 days.

allowCommentsboolean required

When true, comments are enabled on workflow runs created from this workflow.

sharedRunsByDefaultboolean required

When true, new workflow runs created from this workflow have their share link enabled by default. Recipients of the share link can fill in form fields and complete tasks without a Process Street account.

referenceIdstring

Version prefix used when version control is enabled on this workflow. Combined with the version number to form the full version identifier.

Example request

{
  "folderId": "tZHorJg1ZbRKYI9H0ZhMPQ"
}

Response

Example response

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