Update a file record

​
Path Parameters
  • fileId
    Type: integer
    required

    ID of file

Body·
required
application/json
  • statusSystemId
    Type: integer
    required

    ID of the system status that determines the file lifecycle stage

  • customFieldsValues
    Type: array object[] ·

    Values of space-specific custom fields attached to this file

    A single custom field value attached to a record. The field is identified either by customFieldInputId, or by customFieldInputName + module. Values of computed fields (inputType calculation and rollup) are read-only: a calculation value is evaluated at read time from the field's inputCalculation formula and never stored, a rollup value is recomputed automatically from related records; writes to either are ignored.

  • customType
    Type: integer

    ID of the custom type classification applied to this file

  • isFeaturedImage
    Type: boolean

    When true, this image is used as the featured/cover image for the parent record

  • labels
    Type: array array object[][] ·

    Labels attached to this file

  • name
    Type: string

    Original file name (human-readable)

  • path
    Type: string

    Relative storage path where the file is persisted on the server or remote storage

  • resize
    Type: array object[] · Array of thumbnails resizes
  • status
    Type: object ·

    Full Status object for the user-defined status applied to this file

  • statusId
    Type: integer

    ID of the user-defined status applied to this file

  • statusSystem
    Type: object ·

    Full StatusSystem object for the system lifecycle status applied to this file

Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for put/file/{fileId}
curl https://test.boost.space/api/file/1 \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "id": 42,
  "created": "2026-01-15T09:30:00Z",
  "createdUserId": 42,
  "updated": "2026-01-15T09:30:00Z",
  "updatedUserId": 42,
  "statusId": 42,
  "statusSystemId": 42,
  "path": "string",
  "fileName": "Sample fileName",
  "name": "Sample name",
  "type": "string",
  "customType": 1,
  "storage": 1,
  "filesize": "string",
  "boostId": "string",
  "customFieldsValues": [
    {
      "id": 42,
      "created": "2026-01-15T09:30:00Z",
      "valueWysiwyg": "string",
      "valueInt": 1,
      "valueFloat": 1.5,
      "valueDatetime": "2026-01-15T09:30:00Z",
      "valueModule": "string",
      "value": "string",
      "fileId": 42,
      "customFieldInputId": 42,
      "module": "activities",
      "table": "string",
      "entityId": 42,
      "customFieldInputName": "Sample customFieldInputName",
      "selected": true,
      "ipAddress": "string",
      "translatable": true,
      "translations": {
        "en": {
          "field1": "translation1",
          "field2": "translation2"
        },
        "it": {
          "field1": "translation1",
          "field2": "translation2"
        },
        "cs": {
          "field1": "translation1",
          "field2": "translation2"
        }
      }
    }
  ],
  "publicUrl": "https://acme.boost.space",
  "resize": [
    {
      "id": 42,
      "created": "2026-01-15T09:30:00Z",
      "path": "string"
    }
  ],
  "status": {
    "id": 42,
    "created": "2026-01-15T09:30:00Z",
    "created_user_id": 42,
    "name": "Sample name",
    "color": "#1f6feb",
    "icon": "string",
    "icon_prefix": "string",
    "weight": 1,
    "status_system_id": 42,
    "boostId": "string",
    "spaces": [
      1
    ],
    "statusSystem": {
      "id": 42,
      "color": "#1f6feb",
      "icon_prefix": "string",
      "icon": "string",
      "module": "string",
      "weight": 1,
      "name": "Sample name",
      "system_name": "Sample system_name",
      "activated": 1,
      "custom": true,
      "allow_move": "string",
      "boostId": "string"
    }
  },
  "statusSystem": {
    "id": 42,
    "color": "#1f6feb",
    "icon_prefix": "string",
    "icon": "string",
    "module": "string",
    "weight": 1,
    "name": "Sample name",
    "system_name": "Sample system_name",
    "activated": 1,
    "custom": true,
    "allow_move": "string",
    "boostId": "string"
  },
  "labels": [
    [
      {
        "id": 42,
        "created": "2026-01-15T09:30:00Z",
        "createdUserId": 42,
        "updated": "2026-01-15T09:30:00Z",
        "updatedUserId": 42,
        "spaces": {
          "12": [
            "contact",
            "todo"
          ],
          "34": []
        },
        "name": "Sample name",
        "color": "#1f6feb",
        "type": "string",
        "module": "string",
        "editable": true
      }
    ]
  ],
  "isFeaturedImage": true,
  "usage": [
    [
      {
        "name": 1
      }
    ]
  ]
}'

{
  "id": 42,
  "created": "2026-01-15T09:30:00Z",
  "createdUserId": 42,
  "updated": "2026-01-15T09:30:00Z",
  "updatedUserId": 42,
  "statusId": 42,
  "statusSystemId": 42,
  "path": "string",
  "fileName": "Sample fileName",
  "name": "Sample name",
  "type": "string",
  "customType": 1,
  "storage": 1,
  "filesize": "string",
  "boostId": "string",
  "customFieldsValues": [
    {
      "id": 42,
      "created": "2026-01-15T09:30:00Z",
      "valueWysiwyg": "string",
      "valueInt": 1,
      "valueFloat": 1.5,
      "valueDatetime": "2026-01-15T09:30:00Z",
      "valueModule": "string",
      "value": "string",
      "fileId": 42,
      "customFieldInputId": 42,
      "module": "activities",
      "table": "string",
      "entityId": 42,
      "customFieldInputName": "Sample customFieldInputName",
      "selected": true,
      "ipAddress": "string",
      "translatable": true,
      "translations": {
        "en": {
          "field1": "translation1",
          "field2": "translation2"
        },
        "it": {
          "field1": "translation1",
          "field2": "translation2"
        },
        "cs": {
          "field1": "translation1",
          "field2": "translation2"
        }
      }
    }
  ],
  "publicUrl": "https://acme.boost.space",
  "resize": [
    {
      "id": 42,
      "created": "2026-01-15T09:30:00Z",
      "path": "string"
    }
  ],
  "status": {
    "id": 42,
    "created": "2026-01-15T09:30:00Z",
    "created_user_id": 42,
    "name": "Sample name",
    "color": "#1f6feb",
    "icon": "string",
    "icon_prefix": "string",
    "weight": 1,
    "status_system_id": 42,
    "boostId": "string",
    "spaces": [
      1
    ],
    "statusSystem": {
      "id": 42,
      "color": "#1f6feb",
      "icon_prefix": "string",
      "icon": "string",
      "module": "string",
      "weight": 1,
      "name": "Sample name",
      "system_name": "Sample system_name",
      "activated": 1,
      "custom": true,
      "allow_move": "string",
      "boostId": "string"
    }
  },
  "statusSystem": {
    "id": 42,
    "color": "#1f6feb",
    "icon_prefix": "string",
    "icon": "string",
    "module": "string",
    "weight": 1,
    "name": "Sample name",
    "system_name": "Sample system_name",
    "activated": 1,
    "custom": true,
    "allow_move": "string",
    "boostId": "string"
  },
  "labels": [
    [
      {
        "id": 42,
        "created": "2026-01-15T09:30:00Z",
        "createdUserId": 42,
        "updated": "2026-01-15T09:30:00Z",
        "updatedUserId": 42,
        "spaces": {
          "12": [
            "contact",
            "todo"
          ],
          "34": []
        },
        "name": "Sample name",
        "color": "#1f6feb",
        "type": "string",
        "module": "string",
        "editable": true
      }
    ]
  ],
  "isFeaturedImage": true,
  "usage": [
    [
      {
        "name": 1
      }
    ]
  ]
}

File update