Files

POST

/files

You can save a file against a property, opportunity or job and it'll show in the relevant timeline or files tab in Commusoft. Please note as you are esnding a file you will need to change the body request to form-data rather than JSON.

Request

Body Params multipart/form-dataRequired

Responses

🟢200Success

application/json

Bodyapplication/json

🟠401401 Unauthorised

🟠403403 Forbidden

🟠404404 Not found

🟠409409 Conflict

🟠429429 Too many requests

Request Example

Shell

JavaScript

Java

Swift

curl --location '/files' \
--form 'url="https://randomimageurl.com/assets/images/local/sample-2_compressed_q80.jpeg"' \
--form 'parentType="opportunity"' \
--form 'parentID="1347"' \
--form 'fileName="sample-2_compressed_q80.jpeg"' \
--form 'type="jpeg"' \
--form 'sharedOnMobile="true"' \
--form 'shareOnCustomerPortal="false"'

Response Example

200 - Example 1

{
    "id": 0,
    "createdByType": "string",
    "createdByID": 0,
    "createdByUser": "string",
    "createdOnDateTime": "2019-08-24T14:15:22.123Z",
    "lastUpdatedOnDateTime": "2019-08-24T14:15:22.123Z",
    "parentType": "property",
    "parentID": 0,
    "fileName": "string",
    "size": 0,
    "type": "string",
    "sharedOnMobile": true,
    "shareOnCustomerPortal": true,
    "tags": [
        {
            "id": 0,
            "tagName": "string"
        }
    ],
    "url": "string"
}

Modified at 2026-10-30 07:29:15

File tags

Files