Path parameters

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.

    • The timestamp of when the resource was created.

    • The timestamp of when the resource was updated.

    • name string

      Folder name

    • slug string

      Slug of the folder name

    • path string

      Folder path

    • Denotes whether clients can access this folder and files

    • Denotes whether clients can upload files to this folder

    • Denotes whether the option to change client permissions is enabled which depends on the firm show pseudo folders in client portal setting

    • Denotes if this folder is a system folder

    • Denotes if this folder is a pseudo folder

    • Denotes if this folder is a root folder of a documentable item

    • The documentable type such as account/plan/case/etc the file was uploaded to

    • The UUID of the documentable resource

    • The documentable the file was uploaded to

    • Number of accounts this folder has been directly shared with

    • participants array[object]

      Participants whom this folder has been directly shared with.

    • Number of subfolders within the folder

    • folders array[object]

      Subfolders within the folder.

    • Number of files stored in the folder

    • files array[object]

      Files stored in the folder.

    • parents array[object]

      Parent folders.

    • ancestors array[object]

      All parents folders up the folder heirarchy structure.

    • children array[object]

      Subfolders within the folder.

    • 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

PUT /api/v1/folder/{uuid}
curl \
 --request PUT 'https://api.plannrcrm.com/api/v1/folder/uuid' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --data '{"name":false,"parent":"f5872531-1ab9-44c7-883a-2788ba121455"}'
Request examples
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json

# Payload
{
  "name": false,
  "parent": "f5872531-1ab9-44c7-883a-2788ba121455"
}
Response examples (200)
{
  "name": "Important Documents",
  "path": "Codepotato/Important Documents",
  "slug": "important-documents",
  "uuid": "b0923a72-e1c4-4c80-9bda-60908471c9f5",
  "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": "701a1219-82bb-4f7d-b930-e680cea2f2c4",
      "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": "1d9e91c9-61a2-4a32-8920-f4d7413fd8cd"
      },
      "created_at": "2025-04-22T13:44:19+01:00",
      "updated_at": "2025-04-22T13:44:19+01:00",
      "folder_name": "folder 2",
      "uploaded_at": "2025-04-22T13:44:19+01:00",
      "documentable": "Object",
      "download_url": "https://plannr.valet/file/ebcb0a63-d32d-4df6-ab62-fde4936683e7/download",
      "last_modified": "2025-04-22T13:44:19+01:00",
      "documentable_type": "account",
      "original_created_at": "2025-04-22T13:44:19+01:00"
    }
  ],
  "owned": false,
  "folders": [
    {
      "name": "Important Documents",
      "path": "Codepotato/Important Documents",
      "slug": "important-documents",
      "uuid": "a7aec5c6-64b0-4d79-b64b-2f3c62230bbd",
      "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-04-22T13:44:19+01:00",
      "updated_at": "2025-04-22T13:44:19+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": "f70065a3-1eff-4763-9e5c-979cf8657ad0",
      "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-04-22T13:44:19+01:00",
      "updated_at": "2025-04-22T13:44:19+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": "e33331d3-3f8d-413f-8388-99f07e517107",
      "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-04-22T13:44:19+01:00",
      "updated_at": "2025-04-22T13:44:19+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": "7ed4b294-5817-470d-9d20-50086f985847",
      "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-04-22T13:44:19+01:00",
      "updated_at": "2025-04-22T13:44:19+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-04-22T13:44:19+01:00",
  "updated_at": "2025-04-22T13:44:19+01:00",
  "files_count": 8,
  "clients_read": true,
  "documentable": "Object",
  "participants": [
    {
      "name": "Gareth Thompson",
      "uuid": "30329a54-2219-4107-858c-5c471455e59b",
      "write": true,
      "created_at": "2025-04-22T13:44:19+01:00",
      "updated_at": "2025-04-22T13:44:19+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
}