Headers
-
Content-Type
string -
Accept
string
Body
Required
-
name
string Required The name of the file.
-
file
multipart-file Required The file being uploaded.
-
folder_uuid
string Required The UUID of the folder to upload the file to.
-
original_created_at
date The original created at date of the file.
POST
/api/v1/file/direct-upload
curl \
--request POST 'https://api.plannrcrm.com/api/v1/file/direct-upload' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: multipart/form-data" \
--header "Accept: application/json" \
--form "name=Plannr Welcome Pack" \
--form "file=my-file.pdf" \
--form "folder_uuid=c603cf11-1c8d-43b4-b65c-2946eb4a9ba6" \
--form "original_created_at=2025-04-22 13:44:19"
Response examples (201)
{
"firm": {
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "0f08009c-9190-43fc-a520-8fc43b5df185",
"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-22T13:44:19+01:00",
"updated_at": "2025-04-22T13:44:19+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": "633a9e93-6faa-4110-941d-0684d9bb7a0d",
"colour": "#ef4582",
"created_at": "2025-04-22T13:44:19+01:00",
"updated_at": "2025-04-22T13:44:19+01:00"
}
],
"type": "type",
"uuid": "5589f282-e5f3-4355-ae66-9e0d05968cc9",
"folder": {
"name": "Important Documents",
"path": "Codepotato/Important Documents",
"slug": "important-documents",
"uuid": "73e4d5c0-9db1-4c76-9df9-37dbace898ca",
"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
},
"status": "uploaded",
"account": {
"name": "Gareth Thompson",
"role": "client",
"type": "client",
"uuid": "04fb8bda-d0b8-46aa-a3ca-7cd3c5ff6314",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-04-22T13:44:19+01:00",
"first_name": "Gareth",
"updated_at": "2025-04-22T13:44:19+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"filename": "Welcome to Plannr.pdf",
"progress": "100",
"extension": "pdf",
"navigator": {
"model_type": "account",
"model_uuid": "643b9da6-00c6-43d8-9703-b8ebf6467b05"
},
"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/094532c2-a150-4922-80cb-8ca5b638f8a6/download",
"last_modified": "2025-04-22T13:44:19+01:00",
"documentable_type": "account",
"original_created_at": "2025-04-22T13:44:19+01:00"
}