Update and/or move a file

PUT /api/v1/file/{uuid}
Personal access token & O auth2

Path parameters

application/json

Body Required

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • uuid string

      UUID of the file

    • created_at string

      The timestamp of when the resource was created.

    • original_created_at string

      Timestamp of when the file was originally created

    • updated_at string

      The timestamp of when the resource was updated.

    • uploaded_at string

      Timestamp of when the file was uploaded

    • status string

      Current status of the uploading progress

    • filename string

      The filename including extension

    • name string

      The name of the file without extension

    • extension string

      The extension of the file

    • type string

      The MIME type of the file

    • size string

      The size of the file in bytes

    • path string

      The path of the file

    • last_modified string

      Timestamp of when the file was last modified before uploading

    • progress string

      The progress of the uploaded file as a percentage between 0 and 100

    • download_url string

      The download URL of the file

    • folder_name string

      The name of the folder the file is located in

    • folder object

      The folder this file is located in

    • documentable_type string

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

    • documentable string

      The documentable the file was uploaded to

    • navigator object

      The documentable type and its UUID in order to navigator to the correct resource

    • firm object

      The firm which the file belongs to

    • account object

      The account that uploaded the file (if specified)

    • tags array[object]

      The tags added to the file (if provided)
PUT /api/v1/file/{uuid} 
curl \
 --request PUT 'https://api.plannrcrm.com/api/v1/file/uuid' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --data '{"name":"Important Document","folder_uuid":"e2a26499-6147-4b53-9429-d28c48927e7e","original_created_at":"2025-04-02 13:27:56"}'
Request examples 
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json

# Payload
{
  "name": "Important Document",
  "folder_uuid": "e2a26499-6147-4b53-9429-d28c48927e7e",
  "original_created_at": "2025-04-02 13:27:56"
}
Response examples (200) 
{
  "firm": {
    "tax": 17.5,
    "logo": "https://api.plannrcrm.com/images/plannr.jpg",
    "name": "Codepotato",
    "slug": "codepotato",
    "uuid": "c11f24cb-49f3-4dd1-afb8-6e2686888750",
    "county": "Hampshire",
    "billing": {
      "invoice_email": "gareth@codepotato.co.uk",
      "invoice_county": "Hampshire",
      "invoice_country": "United Kingdom",
      "invoice_postcode": "PO7 7YH",
      "invoice_address_1": "Suite E, 5 The Briars",
      "invoice_address_2": "Waterberry Drive",
      "invoice_town_city": "Waterlooville"
    },
    "country": "United Kingdom",
    "postcode": "PO7 7YH",
    "address_1": "Suite E, 5 The Briars",
    "address_2": "Waterberry Drive",
    "logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
    "month_end": 25,
    "town_city": "Waterlooville",
    "created_at": "2025-04-02T13:27:56+01:00",
    "updated_at": "2025-04-02T13:27:56+01:00",
    "ip_whitelist": [
      "192.168.0.1",
      "127.0.0.1"
    ],
    "brand_colours": {
      "sidebar_text": "#ffffff",
      "sidebar_hover": "#0A0A42",
      "email_sub_text": "#ffffff",
      "sidebar_accent": "#36367E",
      "sidebar_active": "#53DBB8",
      "email_background": "#0E0E56",
      "email_button_text": "#ffffff",
      "sidebar_background": "#0E0E56",
      "sidebar_title_primary": "#FFC634",
      "email_button_background": "#36367E",
      "sidebar_title_secondary": "#ffffff",
      "sidebar_title_background": "#36367E",
      "email_logo_background_panel": "#36367E",
      "sidebar_title_secondary_hover": "#ffffff"
    },
    "is_subscribed": true,
    "regulatory_text": "Regulatory text",
    "addon_subscriptions": "App\\Http\\Resources\\Addons\\AddonSubscriptionResource",
    "statement_frequency": "monthly",
    "task_board_template": "App\\Http\\Resources\\Board\\BoardResource",
    "keep_deleted_files_for": 30,
    "welcome_paragraph_html": "<h1>Welcome.</h1>",
    "email_welcome_paragraph_html": "Welcome to Plannr!",
    "show_fact_find_illustrations": true
  },
  "name": "Welcome to Plannr",
  "path": "Gareth Thompson/Subfolder/Welcome to Plannr.pdf",
  "size": "21691783",
  "tags": [
    {
      "name": "Mortgage",
      "slug": "mortgage",
      "uuid": "97184587-50d2-415e-bdec-283edd8a2dd4",
      "colour": "#ef4582",
      "created_at": "2025-04-02T13:27:56+01:00",
      "updated_at": "2025-04-02T13:27:56+01:00"
    }
  ],
  "type": "type",
  "uuid": "31ea0c0a-9d3e-4583-8164-9c28dafa4267",
  "folder": {
    "name": "Important Documents",
    "path": "Codepotato/Important Documents",
    "slug": "important-documents",
    "uuid": "fce0d23b-b431-4e2c-bfc3-59413d14370d",
    "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-02T13:27:56+01:00",
    "updated_at": "2025-04-02T13:27:56+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
  },
  "status": "uploaded",
  "account": {
    "name": "Gareth Thompson",
    "role": "client",
    "type": "client",
    "uuid": "da6062a5-36ab-4752-b88c-6951abdbc56d",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-04-02T13:27:56+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-04-02T13:27:56+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "filename": "Welcome to Plannr.pdf",
  "progress": "100",
  "extension": "pdf",
  "navigator": {
    "model_type": "account",
    "model_uuid": "d2b69f8c-c7b8-45f3-ae73-ceb1a966fc7e"
  },
  "created_at": "2025-04-02T13:27:56+01:00",
  "updated_at": "2025-04-02T13:27:56+01:00",
  "folder_name": "folder 2",
  "uploaded_at": "2025-04-02T13:27:56+01:00",
  "documentable": "Object",
  "download_url": "https://plannr.valet/file/25d6cc85-5aa3-4337-b23c-870fbafc9124/download",
  "last_modified": "2025-04-02T13:27:56+01:00",
  "documentable_type": "account",
  "original_created_at": "2025-04-02T13:27:56+01:00"
}