Path parameters

  • folder_uuid string Required
application/json

Body

  • 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[object]

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

    Hide participants attributes Show participants attributes object
    • uuid string(uuid)

      The UUID of the participant to give permissions to.

    • write boolean

      Write permission for this participant.

Responses

  • 401 application/json
    Hide response attribute Show response attribute object
    • message string
POST /api/v1/folder/{folder_uuid}/permissions
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/folder/6ff8f7f6-1eb3-3525-be4a-3932c805afed/permissions' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"clients_read":false,"clients_write":false,"participants":[{"uuid":"c332c775-5b5a-4d08-8ff6-f7b3123e16e1","write":false},{"uuid":"4ddc02e4-753d-40ed-8314-08dd8b536567","write":true}]}'
Request examples
{
  "clients_read": false,
  "clients_write": false,
  "participants": [
    {
      "uuid": "c332c775-5b5a-4d08-8ff6-f7b3123e16e1",
      "write": false
    },
    {
      "uuid": "4ddc02e4-753d-40ed-8314-08dd8b536567",
      "write": true
    }
  ]
}
Response examples (401)
{
  "message": "Unauthenticated."
}