Cancel

put

Cancels a pending transfer. This operation can be performed only if the transfer has not been completed yet. After cancellation the transfer is not available and any uploaded files are scheduled for removal from our servers.

Body

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

transferidstring · min: 1Required

ID of the transfer to be cancelled (retrevied in the 'Initialize' response).

transferkeystring · min: 1Required

Secret key of the transfer to be cancelled (retrevied in the 'Initialize' response).

Responses

200

OK

text/plainapplication/jsontext/json

responsestatusstring · enumOptionalPossible values:

erroridstring · nullableOptional

errormessagestring · nullableOptional

dataany · nullableOptional

This field contains endpoint-sepcific response data.

errorcodeinteger · int32 · nullableRead-onlyOptional

Numeric representation of the responsestatus field.

400

Bad Request

text/plainapplication/jsontext/json

put

/transfer/cancel

HTTPcURLJavaScriptPython

PUT /transfer/cancel HTTP/1.1
Host: api-public.filemail.com
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 42

{
  "transferid": "text",
  "transferkey": "text"
}

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

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