Update and/or move folders

PUT /api/v1/folder/{uuid}

Personal access token & O auth2

Path parameters

uuid string Required

application/json

Body

name string

Important Documents
parent string

Move current folder in to this parent folder.

Responses

200 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- name string
  
  Folder name
- slug string
  
  Slug of the folder name
- path string
  
  Folder path
- clients_read boolean
  
  Denotes whether clients can access this folder and files
- clients_write boolean
  
  Denotes whether clients can upload files to this folder
- show_client_permissions boolean
  
  Denotes whether the option to change client permissions is enabled which depends on the firm show pseudo folders in client portal setting
- is_system_folder boolean
  
  Denotes if this folder is a system folder
- is_pseudo_folder boolean
  
  Denotes if this folder is a pseudo folder
- is_root_folder boolean
  
  Denotes if this folder is a root folder of a documentable item
- documentable_type string
  
  The documentable type such as account/plan/case/etc the file was uploaded to
- documentable_uuid string
  
  The UUID of the documentable resource
- documentable string
  
  The documentable the file was uploaded to
- participants_count integer
  
  Number of accounts this folder has been directly shared with
- participants array[object]
  
  Participants whom this folder has been directly shared with.
  
  Hide participants attributes Show participants attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  write boolean
- folders_count integer
  
  Number of subfolders within the folder
- folders array[object]
  
  Subfolders within the folder.
  
  Hide folders attributes Show folders attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  slug string
  
  path string
  
  clients_read boolean
  
  clients_write boolean
  
  show_client_permissions boolean
  
  is_system_folder boolean
  
  is_pseudo_folder boolean
  
  is_root_folder boolean
  
  documentable_type string
  
  documentable_uuid string
  
  documentable string
  
  participants_count integer
  
  participants string
  
  folders_count integer
  
  folders string
  
  files_count integer
  
  files string
  
  parents string
  
  ancestors string
  
  children string
  
  depth integer
  
  owned boolean
- files_count integer
  
  Number of files stored in the folder
- files array[object]
  
  Files stored in the folder.
  
  Hide files attributes Show files attributes object
  
  uuid string
  
  created_at string
  
  original_created_at string
  
  updated_at string
  
  uploaded_at string
  
  status string
  
  filename string
  
  name string
  
  extension string
  
  type string
  
  size string
  
  path string
  
  last_modified string
  
  progress string
  
  download_url string
  
  folder_name string
  
  folder string
  
  documentable_type string
  
  documentable string
  
  navigator object
  
  Hide navigator attributes Show navigator attributes object
  
  model_type string
  
  model_uuid string
  
  firm string
  
  account string
  
  tags string
- parents array[object]
  
  Parent folders.
  
  Hide parents attributes Show parents attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  slug string
  
  path string
  
  clients_read boolean
  
  clients_write boolean
  
  show_client_permissions boolean
  
  is_system_folder boolean
  
  is_pseudo_folder boolean
  
  is_root_folder boolean
  
  documentable_type string
  
  documentable_uuid string
  
  documentable string
  
  participants_count integer
  
  participants string
  
  folders_count integer
  
  folders string
  
  files_count integer
  
  files string
  
  parents string
  
  ancestors string
  
  children string
  
  depth integer
  
  owned boolean
- ancestors array[object]
  
  All parents folders up the folder hierarchy structure.
  
  Hide ancestors attributes Show ancestors attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  slug string
  
  path string
  
  clients_read boolean
  
  clients_write boolean
  
  show_client_permissions boolean
  
  is_system_folder boolean
  
  is_pseudo_folder boolean
  
  is_root_folder boolean
  
  documentable_type string
  
  documentable_uuid string
  
  documentable string
  
  participants_count integer
  
  participants string
  
  folders_count integer
  
  folders string
  
  files_count integer
  
  files string
  
  parents string
  
  ancestors string
  
  children string
  
  depth integer
  
  owned boolean
- children array[object]
  
  Subfolders within the folder.
  
  Hide children attributes Show children attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  slug string
  
  path string
  
  clients_read boolean
  
  clients_write boolean
  
  show_client_permissions boolean
  
  is_system_folder boolean
  
  is_pseudo_folder boolean
  
  is_root_folder boolean
  
  documentable_type string
  
  documentable_uuid string
  
  documentable string
  
  participants_count integer
  
  participants string
  
  folders_count integer
  
  folders string
  
  files_count integer
  
  files string
  
  parents string
  
  ancestors string
  
  children string
  
  depth integer
  
  owned boolean
- depth integer
  
  How many levels deep there are to this folder hierarchy structure
- owned boolean
  
  Is true if the authenticated account in the request has created this folder

PUT /api/v1/folder/{uuid}

curl \
 --request PUT 'https://api.plannrcrm.com/api/v1/folder/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"name":false,"parent":"8300ce32-9137-41ac-ab7f-2efe2152d45d"}'

Request examples

{
  "name": false,
  "parent": "8300ce32-9137-41ac-ab7f-2efe2152d45d"
}

Response examples (200)

{
  "name": "Important Documents",
  "path": "Codepotato/Important Documents",
  "slug": "important-documents",
  "uuid": "1e358b94-f9fd-4c2d-95af-50122c7ba4d2",
  "depth": 5,
  "files": [
    {
      "firm": "App\\Http\\Resources\\FirmResource",
      "name": "Welcome to Plannr",
      "path": "Gareth Thompson/Subfolder/Welcome to Plannr.pdf",
      "size": "21691783",
      "tags": "App\\Http\\Resources\\TagResource",
      "type": "type",
      "uuid": "77b3510b-07a4-45e3-852c-701aa9285cd8",
      "folder": "App\\Http\\Resources\\FolderResource",
      "status": "uploaded",
      "account": "App\\Http\\Resources\\MinimalAccountResource",
      "filename": "Welcome to Plannr.pdf",
      "progress": "100",
      "extension": "pdf",
      "navigator": {
        "model_type": "account",
        "model_uuid": "d218e65b-7fe6-48d4-a005-ddb1049aa7f7"
      },
      "created_at": "2025-08-27T17:31:26+01:00",
      "updated_at": "2025-08-27T17:31:26+01:00",
      "folder_name": "folder 2",
      "uploaded_at": "2025-08-27T17:31:26+01:00",
      "documentable": "Object",
      "download_url": "https://api.plannrcrm.com/file/c48dd221-a6e0-427f-948f-1e9687c0fb98/download",
      "last_modified": "2025-08-27T17:31:26+01:00",
      "documentable_type": "account",
      "original_created_at": "2025-08-27T17:31:26+01:00"
    }
  ],
  "owned": false,
  "folders": [
    {
      "name": "Important Documents",
      "path": "Codepotato/Important Documents",
      "slug": "important-documents",
      "uuid": "6f0a5a40-dadb-4f1e-9c64-f6cd7464ac1c",
      "depth": 5,
      "files": "App\\Http\\Resources\\FileResource",
      "owned": false,
      "folders": "App\\Http\\Resources\\FolderResource",
      "parents": "App\\Http\\Resources\\FolderResource",
      "children": "App\\Http\\Resources\\FolderResource",
      "ancestors": "App\\Http\\Resources\\FolderResource",
      "created_at": "2025-08-27T17:31:26+01:00",
      "updated_at": "2025-08-27T17:31:26+01:00",
      "files_count": 8,
      "clients_read": true,
      "documentable": "Object",
      "participants": "App\\Http\\Resources\\FolderParticipantResource",
      "clients_write": true,
      "folders_count": 5,
      "is_root_folder": true,
      "is_pseudo_folder": true,
      "is_system_folder": true,
      "documentable_type": "account",
      "documentable_uuid": "account",
      "participants_count": 3,
      "show_client_permissions": true
    }
  ],
  "parents": [
    {
      "name": "Important Documents",
      "path": "Codepotato/Important Documents",
      "slug": "important-documents",
      "uuid": "885cd725-6a4a-43c6-8795-d1d905d1e35b",
      "depth": 5,
      "files": "App\\Http\\Resources\\FileResource",
      "owned": false,
      "folders": "App\\Http\\Resources\\FolderResource",
      "parents": "App\\Http\\Resources\\FolderResource",
      "children": "App\\Http\\Resources\\FolderResource",
      "ancestors": "App\\Http\\Resources\\FolderResource",
      "created_at": "2025-08-27T17:31:26+01:00",
      "updated_at": "2025-08-27T17:31:26+01:00",
      "files_count": 8,
      "clients_read": true,
      "documentable": "Object",
      "participants": "App\\Http\\Resources\\FolderParticipantResource",
      "clients_write": true,
      "folders_count": 5,
      "is_root_folder": true,
      "is_pseudo_folder": true,
      "is_system_folder": true,
      "documentable_type": "account",
      "documentable_uuid": "account",
      "participants_count": 3,
      "show_client_permissions": true
    }
  ],
  "children": [
    {
      "name": "Important Documents",
      "path": "Codepotato/Important Documents",
      "slug": "important-documents",
      "uuid": "db86f421-2a07-491d-a9a7-868e52f2fad0",
      "depth": 5,
      "files": "App\\Http\\Resources\\FileResource",
      "owned": false,
      "folders": "App\\Http\\Resources\\FolderResource",
      "parents": "App\\Http\\Resources\\FolderResource",
      "children": "App\\Http\\Resources\\FolderResource",
      "ancestors": "App\\Http\\Resources\\FolderResource",
      "created_at": "2025-08-27T17:31:26+01:00",
      "updated_at": "2025-08-27T17:31:26+01:00",
      "files_count": 8,
      "clients_read": true,
      "documentable": "Object",
      "participants": "App\\Http\\Resources\\FolderParticipantResource",
      "clients_write": true,
      "folders_count": 5,
      "is_root_folder": true,
      "is_pseudo_folder": true,
      "is_system_folder": true,
      "documentable_type": "account",
      "documentable_uuid": "account",
      "participants_count": 3,
      "show_client_permissions": true
    }
  ],
  "ancestors": [
    {
      "name": "Important Documents",
      "path": "Codepotato/Important Documents",
      "slug": "important-documents",
      "uuid": "47a7b9f6-7e9a-44f8-a673-313213f1bf1e",
      "depth": 5,
      "files": "App\\Http\\Resources\\FileResource",
      "owned": false,
      "folders": "App\\Http\\Resources\\FolderResource",
      "parents": "App\\Http\\Resources\\FolderResource",
      "children": "App\\Http\\Resources\\FolderResource",
      "ancestors": "App\\Http\\Resources\\FolderResource",
      "created_at": "2025-08-27T17:31:26+01:00",
      "updated_at": "2025-08-27T17:31:26+01:00",
      "files_count": 8,
      "clients_read": true,
      "documentable": "Object",
      "participants": "App\\Http\\Resources\\FolderParticipantResource",
      "clients_write": true,
      "folders_count": 5,
      "is_root_folder": true,
      "is_pseudo_folder": true,
      "is_system_folder": true,
      "documentable_type": "account",
      "documentable_uuid": "account",
      "participants_count": 3,
      "show_client_permissions": true
    }
  ],
  "created_at": "2025-08-27T17:31:26+01:00",
  "updated_at": "2025-08-27T17:31:26+01:00",
  "files_count": 8,
  "clients_read": true,
  "documentable": "Object",
  "participants": [
    {
      "name": "Gareth Thompson",
      "uuid": "a047a877-935e-4dcb-a5d0-9ad3293960b9",
      "write": true,
      "created_at": "2025-08-27T17:31:26+01:00",
      "updated_at": "2025-08-27T17:31:26+01:00"
    }
  ],
  "clients_write": true,
  "folders_count": 5,
  "is_root_folder": true,
  "is_pseudo_folder": true,
  "is_system_folder": true,
  "documentable_type": "account",
  "documentable_uuid": "account",
  "participants_count": 3,
  "show_client_permissions": true
}