files

Upload a file

Upload a file onto a parent record (multipart field file). Optional description. Requires edit on the parent module. Uploads have a stricter rate limit than other API calls (15/min). Not available for tickets (read-only).

POST

/{module}/{uuid}/files

Upload a file

curl --request POST \
  --url https://default.hannacrm.app/api/v4/{module}/{uuid}/files \
  --header 'Authorization: Bearer <token>' \
  --form 'description=<string>' \
  --form 'file=<string>'

{
  "record": {
    "content_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "file_name": "<string>",
    "filesize": 123,
    "filetype": "<string>",
    "reply": {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "visible_to_customer": true
  }
}

Authorizations

Authorizationstringheaderrequired

API key (Bearer token) created in Setup → API & MCP.

Path Parameters

moduleenum<string>required

Parent API v4 module. Files land on that record’s Files tab.

Available options: projects, clients, leads, objects, opportunities, invoices, credit_notes, expenses, contracts, documents, pre_invoices

uuidstringrequired

Parent record UUID.

Body

descriptionstring

Optional file description.

filestringrequired

The file to attach. Types follow the account’s allowed upload formats.

Response

File stored on the parent record.

recordobject

Show child attributes

Still need help? Ask the team