Editing a transfer

put

Updates basic properties of a transfer.

Path parameters

transferidstringRequired

The transfer ID - unique transfer identifier. It is returned after initializing a transfer, also it is available in transfer list responses (sent and received).

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

daysinteger · int32 · nullableOptional

The number of days until the transfer expires. Expiration is counted since the date of transfer creation. Use -1 to change make this transfer permanent (one that never expires).

notifyboolean · nullableOptional

Decides whether transfer sender receives email notifications when the transfer is downloaded.

subjectstring · max: 200 · nullableOptional

Updates the transfer subject.

messagestring · max: 5000 · nullableOptional

Updates the transfer message / description.

passwordstring · max: 100 · nullableOptional

Sets transfer password. Specify empty string in this field to remove existing password.

Responses

200

OK

text/plainapplication/jsontext/json

responsestatusstring · enumOptionalPossible values:

erroridstring · nullableOptional

errormessagestring · nullableOptional

errorcodeinteger · int32 · nullableRead-onlyOptional

Numeric representation of the responsestatus field.

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

text/plainapplication/jsontext/json

put

/transfer/{transferid}

HTTPcURLJavaScriptPython

PUT /transfer/{transferid} HTTP/1.1
Host: api-public.filemail.com
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 76

{
  "days": 1,
  "notify": true,
  "subject": "text",
  "message": "text",
  "password": "text"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

{
  "responsestatus": "OK",
  "errorid": "text",
  "errormessage": "text",
  "data": {
    "recipients": [
      {
        "email": "text",
        "downloadlink": "text",
        "delivered": true,
        "deliveryerror": "text"
      }
    ],
    "failedRecipients": 1,
    "from": "text",
    "subject": "text",
    "message": "text",
    "expiredate": 1,
    "extendedexpiredate": 1,
    "sentdate": 1,
    "notify": true,
    "status": "text",
    "id": "text",
    "trackid": "text",
    "url": "text",
    "size": 1,
    "customlogourl": "text",
    "compressedfileurl": "text",
    "compressedfilestatus": "text",
    "compressedfileformat": "text",
    "torrentstatus": "text",
    "torrenturl": "text",
    "days": 1,
    "isexpired": true,
    "source": "text",
    "key": "text",
    "fileserver": "text",
    "fileserverurl": "text",
    "fileserverurl_main": "text",
    "footertext": "text",
    "containsmorefiles": 1,
    "customfields": [
      {
        "customfieldid": "text",
        "defaultvalue": "text",
        "description": "text",
        "label": "text",
        "customLabel": "text",
        "listitems": "text",
        "required": true,
        "visible": true,
        "type": "text",
        "rendertype": 1,
        "sortorder": 1,
        "length": 1,
        "startValue": 1,
        "placeholder": "text",
        "removable": true,
        "editableType": true,
        "editableRequired": true,
        "value": "text",
        "barcodeimage": "text"
      }
    ],
    "files": [
      {
        "filename": "text",
        "filesize": 1,
        "downloadurl": "text",
        "fileid": "text",
        "thumbid": "text",
        "previewurl": "text",
        "hascustompreview": true,
        "videopreview": {
          "ANY_ADDITIONAL_PROPERTY": {
            "size": 1,
            "resolution": 1,
            "downloadUrl": "text"
          }
        },
        "downloads": [
          {
            "downloaddate": 1,
            "ip": "text",
            "email": "text",
            "location": "text",
            "locationurl": "text",
            "locationflag": "text",
            "kBps": 1,
            "filename": "text",
            "filesize": 1,
            "downloadtype": "SingleFile"
          }
        ],
        "filetype": "text",
        "filetypedescription": "text",
        "category": "text",
        "smallpreview": "text",
        "mediumpreview": "text",
        "largepreview": "text",
        "hascustomthumbnail": true,
        "transferid": "text",
        "md5": "text",
        "suspecteddamage": true
      }
    ],
    "numberoffiles": 1,
    "numberofdownloads": 1,
    "downloads": [
      {
        "downloaddate": 1,
        "ip": "text",
        "email": "text",
        "location": "text",
        "locationurl": "text",
        "locationflag": "text",
        "kBps": 1,
        "filename": "text",
        "filesize": 1,
        "downloadtype": "SingleFile"
      }
    ],
    "antivirusscanstatus": "text",
    "passwordprotected": true,
    "iconcolor": "text",
    "iconletter": "text",
    "ftphost": "text",
    "region": "text",
    "protocol": "text",
    "e2ee": true,
    "kind": "text",
    "ftpcorppasswordrequired": true,
    "udpthreshold": 1,
    "permanent": true,
    "maxdays": 1,
    "allowediting": true,
    "alloweditingexpiredate": true,
    "blockdownloads": true,
    "infected": true,
    "infected_deleted": [
      "text"
    ]
  },
  "errorcode": 1
}