Create a folder

POST /api/v1/folder

To create a subfolder pass the parent folder UUID under parent key. This subfolder will inherit the documentable_type and documentable_uuid of its parent folder.

Headers

Authorization string
Content-Type string
Accept string

application/json

Body Required

name string Required

Folder name.
parent string Required

Parent folder UUID to create this folder under.

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.
  
  Additional properties are allowed.
- folders_count integer
  
  Number of subfolders within the folder
- folders array[object]
  
  Subfolders within the folder.
  
  Additional properties are allowed.
- files_count integer
  
  Number of files stored in the folder
- files array[object]
  
  Files stored in the folder.
  
  Additional properties are allowed.
- parents array[object]
  
  Parent folders.
  
  Additional properties are allowed.
- ancestors array[object]
  
  All parents folders up the folder heirarchy structure.
  
  Additional properties are allowed.
- children array[object]
  
  Subfolders within the folder.
  
  Additional properties are allowed.
- depth integer
  
  How many levels deep there are to this folder heirarchy structure
- owned boolean
  
  Is true if the authenticated account in the request has created this folder

POST /api/v1/folder

curl \
 --request POST https://api.plannrcrm.com/api/v1/folder \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --data '{"name":"Important Documents","parent":"string"}'

Request examples

# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json

# Payload
{
  "name": "Important Documents",
  "parent": "string"
}

Response examples (200)

{
  "name": "Important Documents",
  "path": "Codepotato/Important Documents",
  "slug": "important-documents",
  "uuid": "654f0e93-dd5d-4a3b-a25d-9d311f9c077e",
  "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": "589f1d29-3d50-4314-96b6-0c5567a618c8",
      "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": "e6dbc1ee-3bd8-4919-90be-bddf564ba7f1"
      },
      "created_at": "2025-02-20T10:13:03+00:00",
      "updated_at": "2025-02-20T10:13:03+00:00",
      "folder_name": "folder 2",
      "uploaded_at": "2025-02-20T10:13:03+00:00",
      "documentable": "Object",
      "download_url": "https://plannr.valet/file/399b22d0-cfd6-4529-afa9-858b09e31f6a/download",
      "last_modified": "2025-02-20T10:13:03+00:00",
      "documentable_type": "account",
      "original_created_at": "2025-02-20T10:13:03+00:00"
    }
  ],
  "owned": false,
  "folders": [
    {
      "name": "Important Documents",
      "path": "Codepotato/Important Documents",
      "slug": "important-documents",
      "uuid": "a6cb89fd-af66-41fa-a563-617c0e13491f",
      "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-02-20T10:13:03+00:00",
      "updated_at": "2025-02-20T10:13:03+00: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": "3e89ae2d-ed10-4132-9367-3f2ae1870f7a",
      "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-02-20T10:13:03+00:00",
      "updated_at": "2025-02-20T10:13:03+00: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": "f32d9b54-f07a-4bd0-b2d9-c53d56dcc374",
      "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-02-20T10:13:03+00:00",
      "updated_at": "2025-02-20T10:13:03+00: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": "68e06ad6-a59b-4f3f-b422-536dfff74fed",
      "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-02-20T10:13:03+00:00",
      "updated_at": "2025-02-20T10:13:03+00: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-02-20T10:13:03+00:00",
  "updated_at": "2025-02-20T10:13:03+00:00",
  "files_count": 8,
  "clients_read": true,
  "documentable": "Object",
  "participants": [
    {
      "name": "Gareth Thompson",
      "uuid": "d9a5f03b-148d-435b-bda2-329f103cd9c4",
      "write": true,
      "created_at": "2025-02-20T10:13:03+00:00",
      "updated_at": "2025-02-20T10:13:03+00: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
}