Set permissions for a workflow

Replaces the full set of permissions for a workflow. PUT semantics: send the complete list to replace all existing permissions. Send an empty array to remove all user-addressable permissions. Accepts both user emails and group emails (groups appear in other endpoints with synthetic group-<id>@process.st emails). Note: the AllFreeMembers system group is managed automatically by the AllMembers system group and cannot be modified directly. Returns the resulting permissions.

put/workflows/{workflowId}/permissions

Request

Base URL
https://public-api.process.st/api/v1.1
URL
https://public-api.process.st/api/v1.1/workflows/{workflowId}/permissions
Auth
- API key in header X-API-Key
- or HTTP bearer

Path parameters

workflowIdstring required

The ID of the Workflow

Request body

emailstring required

Email address.

accessLevel'Edit' | 'EditViewOwn' | 'ViewAll' | 'Run' | 'View' required

Access level granted to a user or group on this workflow. Edit — edit the workflow, run new workflow runs, and view all runs created from it. EditViewOwn — edit the workflow and run new runs, but only view runs assigned to them (available on some plans). ViewAll — view the workflow and all runs, plus run new runs; cannot edit the workflow. Run — view the workflow, run new runs, and view runs assigned to them. View — view the workflow and only runs assigned to them; cannot run.

Response

Example response

{
  "links": [
    {
      "href": "https://api.process.st/api/v1.1/resource/XXX"
    }
  ]
}

Changes

No recorded changes to this operation across all 16 revisions of this API.