Update folder permissions Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.plannrcrm.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "PlannrCRM MCP server": {
    "url": "https://apidocs.plannrcrm.com/mcp"
  }
}
Close
POST /api/v1/folder/{folder_uuid}/permissions
Personal access token & O auth2

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 Required

      A human-readable description of the error.
  • 422 application/json

    Validation error

    Hide response attributes Show response attributes object
    • message string Required

      A human-readable description of the error.

    • errors object

      Validation messages keyed by the field that failed.

      Hide errors attribute Show errors attribute object
      • * array[string] Additional properties
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": "a8ac89e8-9594-4e20-b7f1-c5418ddf69a5",
      "write": false
    },
    {
      "uuid": "c7dceaf9-0a70-40bf-9bd9-13e408e1650c",
      "write": true
    }
  ]
}'
Request examples 
{
  "clients_read": false,
  "clients_write": false,
  "participants": [
    {
      "uuid": "a8ac89e8-9594-4e20-b7f1-c5418ddf69a5",
      "write": false
    },
    {
      "uuid": "c7dceaf9-0a70-40bf-9bd9-13e408e1650c",
      "write": true
    }
  ]
}
Response examples (401) 
{
  "message": "Unauthenticated."
}
Response examples (422) 
{
  "message": "The given data was invalid.",
  "errors": {
    "field": [
      "The field is invalid."
    ]
  }
}