Skip to main content
POST
/
documents
/
rename
Rename a file or folder
curl --request POST \
  --url https://api.sftpsync.io/documents/rename \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "connectionId": "<string>",
  "path": "<string>",
  "newName": "<string>",
  "force": true
}
'
{
  "renamed": true,
  "path": "<string>"
}

Authorizations

x-api-key
string
header
required

Body

application/json
connectionId
string
required
path
string
required
newName
string
required

Single path segment (no slashes).

force
boolean

Response

Renamed

renamed
enum<boolean>
required
Available options:
true
path
string
required