Copy a file
Copy a file to the current directory or to the given folder.
PUT
/api/v1/file/{file_uuid}/copy
curl \
--request PUT 'https://api.plannrcrm.com/api/v1/file/6ff8f7f6-1eb3-3525-be4a-3932c805afed/copy' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"folder":"cd3f7e09-e5f3-4d6d-9594-cc283577d099"}'
Request examples
{
"folder": "cd3f7e09-e5f3-4d6d-9594-cc283577d099"
}
Response examples (200)
{
"firm": {
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "f3b98ec0-09f9-4389-b240-17a06b8042e1",
"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-08-27T17:31:26+01:00",
"updated_at": "2025-08-27T17:31:26+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",
"portal_background": "#f6f6f6",
"portal_brand_title": "#323b4b",
"sidebar_background": "#0E0E56",
"portal_sidebar_icon": "#828994",
"portal_sidebar_text": "#323b4b",
"portal_sidebar_title": "#11151d",
"sidebar_title_primary": "#FFC634",
"portal_brand_sub_title": "#828994",
"portal_sidebar_divider": "#e3e5e9",
"email_button_background": "#36367E",
"portal_dashboard_bg_one": "#EF4583",
"portal_dashboard_bg_two": "#FFC634",
"sidebar_title_secondary": "#ffffff",
"sidebar_title_background": "#36367E",
"portal_sidebar_icon_hover": "#828994",
"portal_sidebar_text_hover": "#323b4b",
"portal_sidebar_icon_active": "#828994",
"portal_sidebar_text_active": "#323b4b",
"email_logo_background_panel": "#36367E",
"portal_sidebar_button_hover": "#ffffff",
"portal_sidebar_account_email": "#828994",
"portal_sidebar_account_title": "#11151d",
"portal_sidebar_button_active": "#ffffff",
"sidebar_title_secondary_hover": "#ffffff",
"portal_sidebar_collapse_button": "#828994",
"portal_sidebar_button_background": "#f6f6f6",
"portal_sidebar_collapse_button_hover": "#B3B9C4"
},
"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": "a66f7531-bf27-4ab2-ae12-ced47a569d7e",
"colour": "#ef4582",
"created_at": "2025-08-27T17:31:26+01:00",
"updated_at": "2025-08-27T17:31:26+01:00"
}
],
"type": "type",
"uuid": "e8e687ab-475c-49ee-a84f-99724b6d90bd",
"folder": {
"name": "Important Documents",
"path": "Codepotato/Important Documents",
"slug": "important-documents",
"uuid": "052eeda7-14fb-4a6d-b94a-84966704e1f2",
"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
},
"status": "uploaded",
"account": {
"name": "Gareth Thompson",
"role": "client",
"type": "client",
"uuid": "ea143969-4839-4f66-9add-2191bbb2630d",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-08-27T17:31:26+01:00",
"first_name": "Gareth",
"updated_at": "2025-08-27T17:31:26+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"filename": "Welcome to Plannr.pdf",
"progress": "100",
"extension": "pdf",
"navigator": {
"model_type": "account",
"model_uuid": "c66e03fa-602d-4978-bf07-df162d143b79"
},
"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/bd19e0d5-510a-453a-b258-3767896ea97c/download",
"last_modified": "2025-08-27T17:31:26+01:00",
"documentable_type": "account",
"original_created_at": "2025-08-27T17:31:26+01:00"
}