Sign in
latestOpenAPI 3.1.02026-08-171503582.2 MB

6199a9464227

Folders

Set permissions for a folder

Replaces the full set of permissions for a folder. 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/folders/{folderId}/permissions

Path parameters

folderIdstring required

The ID of the Folder

Request body

emailstring required

Email address.

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

Access level granted to a user on this folder. The level cascades to every workflow, page, and run inside the folder.

  • Edit — full edit on the folder and all its contents; can run workflows and view all runs.
  • EditViewOwn — edit folder contents and run workflows, but only see runs assigned to them (available on some plans).
  • ViewAll — view the folder, all its contents, and all runs; can run workflows but cannot edit.
  • Run — view the folder and run its workflows; only sees runs assigned to them.
  • View — view the folder and its contents; cannot run workflows.

Response

Example response

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