---
title: "Create a workflow"
method: POST
path: "/workflows"
tags: ["Workflows"]
---

# Create a workflow

`POST /workflows`

Creates a new workflow with the specified properties. Only name and folderId are required.

> 💡 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.

## Request body

- CreateWorkflowRequest
  - `name` string, required — Display name.
  - `description` string — Optional free-form description of the workflow.
  - `folderId` string, 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.
  - `allowComments` boolean, required — When `true`, comments are enabled on workflow runs created from this workflow.
  - `sharedRunsByDefault` boolean, 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.
  - `referenceId` string — Version prefix used when version control is enabled on this workflow. Combined with the version number to form the full version identifier.

## Response `201`

- PublicApiWorkflowResponse
  - `data` object, required
    - `id` string, required — The resource's ID.
    - `audit` object, required — Creation and last-modification metadata.
      - `createdDate` string, date-time, required — When the resource was first created. ISO-8601 UTC.
      - `createdBy` object, required — User who created the resource.
        - `id` string, required — The resource's ID.
        - `email` string, required — The user's email address (also their login identifier).
        - `username` string, required — The user's display name (e.g. `Jane Doe`).
      - `updatedDate` string, date-time, required — When the resource was last modified. ISO-8601 UTC.
      - `updatedBy` object, required — User who last modified the resource.
        - `id` string, required — The resource's ID.
        - `email` string, required — The user's email address (also their login identifier).
        - `username` string, required — The user's display name (e.g. `Jane Doe`).
    - `name` string, required — The workflow's name.
    - `description` string — Optional long-form description of the workflow.
    - `links` object[] — Navigable HATEOAS links to related resources. Each entry has a `name` (RFC-5988 link relation like `self`, `edit`, `related`), an `href` URL, and a `type` (`Api` for callable endpoints, `App` for browser-facing URLs). Prefer following these `href` values over constructing URLs by hand.
      - `name` string, required — Standard link relation name (RFC 5988) indicating this link's role. Common values include `self`, `edit`, `related`, `previous`, `next`.
      - `href` string, required — URL of the linked resource.
      - `rel` 'Approval Task' | 'Approvals' | 'Assignees' | 'Comment' | 'Data Set Records' | 'Data Sets' | 'Form Field Values' | 'Subject Task' | 'Task' | 'Tasks' | 'Users' | 'Webhook' | 'Workflow' | 'Workflow Run' — Optional. The kind of resource this link points to (e.g. `Workflow`, `Task`, `Comment`).
      - `type` 'Api' | 'App', required — Whether this link targets an API endpoint or a Process Street app URL. `Api` — a callable API endpoint you can fetch directly. `App` — a browser-facing URL in the Process Street UI.
  - `links` object[] — Pagination links. When the result has more pages, look for an entry with `name: "next"` — its `href` is the URL to fetch the next page. Absence of `next` means there are no more pages. For single-resource responses this array is typically empty.
    - `name` string, required — Standard link relation name (RFC 5988) indicating this link's role. Common values include `self`, `edit`, `related`, `previous`, `next`.
    - `href` string, required — URL of the linked resource.
    - `rel` 'Approval Task' | 'Approvals' | 'Assignees' | 'Comment' | 'Data Set Records' | 'Data Sets' | 'Form Field Values' | 'Subject Task' | 'Task' | 'Tasks' | 'Users' | 'Webhook' | 'Workflow' | 'Workflow Run' — Optional. The kind of resource this link points to (e.g. `Workflow`, `Task`, `Comment`).
    - `type` 'Api' | 'App', required — Whether this link targets an API endpoint or a Process Street app URL. `Api` — a callable API endpoint you can fetch directly. `App` — a browser-facing URL in the Process Street UI.

## Other responses

- `400` — Invalid value for: body
- `default`

---

[API](https://skmtc.net/process/apis/process-street-public-api.md) · [All operations](https://skmtc.net/process/apis/process-street-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/process/process-street-public-api/revisions/6199a9464227/schema)