PRprocess
Files

Set permissions for a file

Changed on

Sets who can view or edit a file. Send the complete list of users and groups you want to grant access to; this replaces the permissions managed through this API. Use user emails or the group addresses returned by Get permissions. An empty list removes all permissions you can manage here. Of the system groups, only AllMembers can be set; AllAdmins, AllFreeMembers, AllGuests, and AllAnonymous are managed automatically. Both the submitted and resulting lists are limited to 1000 entries. If either exceeds the limit, nothing changes. Returns the updated permissions.

put/files/{fileId}/permissions

Request

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

Path parameters

fileIdstring required

File ID

Request body

emailstring required

Email address.

accessLevel'Edit' | 'View' required

Access level granted to a user on this file.

  • Edit — view, edit, and delete the file.
  • View — view the file (read-only).

Response

Example response

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

Changes