Update file

updateFile(input: UpdateFileInput!): UpdateFilePayload!

Requires project.files.write.

Arguments

ArgumentTypeRequired
inputUpdateFileInput!Yes

Input fields

input

UpdateFileInput

FieldTypeRequiredDescription
filePathString!Yes
contentString!YesReplacement textual content in main or the selected branch, stored as a new immutable version. Source-file MIME type is not writable.
expectedChecksumStringNoExpected current content checksum. Null or omission disables this guard.
expectedVersionIdStringNoExpected current version ID. Null or omission disables this guard.
refStringNoCanonical 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.
branchIdStringNoLegacy alias for ref=branch:<value>. Supplying both is accepted when they name the same content and rejected when they do not.

Response

Returns UpdateFilePayload!. Open the type for its fields and nested types.

FieldTypeDescription
pathString!
successBoolean!
errorString
idStringFile ID; null when the mutation failed.
versionIdStringVersion ID the write produced; null when the mutation failed.
typeStringFile kind: page, function, component or file; null when the mutation failed.
contentStringContent of the file after the mutation; null when the mutation failed.
sizeBytesIntSize of the content encoded as UTF-8, in bytes; null when the mutation failed.

All fields of UpdateFilePayload.

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

Example

graphql
mutation UpdateFile($input: UpdateFileInput!) {
  updateFile(input: $input) {
    id
    updatedAt
    checksum
    content
    error
  }
}
json
{
  "input": {
    "filePath": "example",
    "content": "example"
  }
}