Sharing a transfer

post

Shares an existing transfer with 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). Sharings does not add new recipients to an existing transfer. Instead it only sends out download links. When sharing with an existing recipient - they will receive their original tracked download link again. When sharing with new recipients - they will receive the general (non-tracked) download link.

Body

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

transferidstring · min: 1Required

Unique identifier of the transfer that should be forwarded.

messagestring · max: 5000Optional

Custom message to be included in the email that will be sent out to recipients.

tostring[]Required

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

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

text/plainapplication/jsontext/json

post

HTTPcURLJavaScriptPython

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

{
  "transferid": "text",
  "message": "text",
  "to": [
    "text"
  ]
}

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

{
  "responsestatus": "OK",
  "errorid": "text",
  "errormessage": "text",
  "data": null,
  "errorcode": 1
}