Renaming a file in a transfer

put

Renames an existing file in a transfer. File names include their relative paths inside a transfer e.g. /path/to/file.pdf. When renaming a file it is required to provide a new relative path. To only rename /path/to/file.pdf without changing its logical location specify /path/to/new_file.pdf.

Body

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

fileKeystring · min: 1Required

File key / identifier which can be obtained from GET /transfer request. Every file in the transfer response includes its unique identifier under fileid property.

newFileNamestring · min: 1 · max: 2000Required

New relative path and name of the file within the 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

put

/transfer/file/rename

HTTPcURLJavaScriptPython

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

{
  "fileKey": "text",
  "newFileName": "text"
}

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

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