Move file - Veryfront

moveFile(input: MoveFileInput!): MoveFilePayload

Requires project.files.write.

Arguments

Argument	Type	Required
`input`	`MoveFileInput!`	Yes

Input fields

input

MoveFileInput

Field	Type	Required	Description
`filePath`	`String`	No	The file to move. Send filePath or sourcePath, not two different values.
`sourcePath`	`String`	No	Earlier spelling of filePath.
`destinationPath`	`String!`	Yes	Destination file path. The source receives a deletion version and the destination receives a new file ID derived from its path; immutable history remains.
`expectedVersionId`	`String`	No	Optional optimistic-concurrency guard: the move is rejected before any mutation when the source file’s current version no longer matches.
`ref`	`String`	No	Canonical content selector: main, branch:<name-or-id>, release:<version> or env:<name>. An unresolvable reference is rejected; it never falls back to main. A release or environment is read-only, so a write addressed to one is refused rather than applied elsewhere.
`branchId`	`String`	No	Legacy alias for ref=branch:<value>. Supplying both is accepted when they name the same content and rejected when they do not.

Response

Returns MoveFilePayload. Open the type for its fields and nested types.

Field	Type	Description
`success`	`Boolean`
`error`	`String`
`path`	`String`
`id`	`String`	ID of the file at its new path; null when the mutation failed.
`versionId`	`String`	Version ID the write produced; null when the mutation failed.
`type`	`String`	File kind: page, function, component or file; null when the mutation failed.
`content`	`String`	Content of the file after the mutation; null when the mutation failed.
`sizeBytes`	`Int`	Size of the content encoded as UTF-8, in bytes; null when the mutation failed.

All fields of MoveFilePayload. Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

mutation MoveFile($input: MoveFileInput!) {
  moveFile(input: $input) {
    id
    updatedAt
    checksum
    content
    error
  }
}

{
  "input": {
    "filePath": "notes.txt",
    "destinationPath": "archive/notes.txt"
  }
}