Update folder permissions

POST /api/v1/folder/{folder_uuid}/permissions

Headers

Path parameters

application/json

Body Required

  • clients_read boolean Required

    Give read access to all clients that can view the documentable item.

  • clients_write boolean Required

    Give write access to all clients that can view the documentable item.

  • participants array[string]

    Give read and write access to specific people that can view the documentable item.

POST /api/v1/folder/{folder_uuid}/permissions
curl \
 --request POST https://api.plannrcrm.com/api/v1/folder/folder_uuid/permissions \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --data '{"clients_read":false,"clients_write":false,"participants":[{"uuid":"f2989c4d-9633-4d3f-803a-a85aace830e0","write":false},{"uuid":"70c868f5-dd94-4bee-b778-2965a74fe2e6","write":true}]}'
Request examples
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json

# Payload
{
  "clients_read": false,
  "clients_write": false,
  "participants": [
    {
      "uuid": "f2989c4d-9633-4d3f-803a-a85aace830e0",
      "write": false
    },
    {
      "uuid": "70c868f5-dd94-4bee-b778-2965a74fe2e6",
      "write": true
    }
  ]
}