Forwarding a transfer

post

Forwards an existing transfer to more recipients. Recipients may be specified using their email address or via contact group names (you need to have these groups defined in the contacts area first). Forwarding adds new recipients to an existing transfer and sends them download links (including tracking data) via email.

Body

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

transferidstring · min: 1Required

Unique identifier of the transfer that should be forwarded.

tostring[]Required

List of email addresses or contact group names which should receive this transfer.

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

post/transfer/forward

HTTPcURLJavaScriptPython

POST /transfer/forward HTTP/1.1
Host: api-public.filemail.com
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 35

{
  "transferid": "text",
  "to": [
    "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
}