Replace pending file draft

curl --request PUT \
  --url https://api.veryfront.com/projects/{project_reference}/branches/{branchName}/files/{filePath}/draft \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": "<string>",
  "expected_draft_version": 1073741823
}
'

import requests

url = "https://api.veryfront.com/projects/{project_reference}/branches/{branchName}/files/{filePath}/draft"

payload = {
    "content": "<string>",
    "expected_draft_version": 1073741823
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({content: '<string>', expected_draft_version: 1073741823})
};

fetch('https://api.veryfront.com/projects/{project_reference}/branches/{branchName}/files/{filePath}/draft', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.veryfront.com/projects/{project_reference}/branches/{branchName}/files/{filePath}/draft",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'content' => '<string>',
    'expected_draft_version' => 1073741823
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.veryfront.com/projects/{project_reference}/branches/{branchName}/files/{filePath}/draft"

	payload := strings.NewReader("{\n  \"content\": \"<string>\",\n  \"expected_draft_version\": 1073741823\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.veryfront.com/projects/{project_reference}/branches/{branchName}/files/{filePath}/draft")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"content\": \"<string>\",\n  \"expected_draft_version\": 1073741823\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.veryfront.com/projects/{project_reference}/branches/{branchName}/files/{filePath}/draft")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"content\": \"<string>\",\n  \"expected_draft_version\": 1073741823\n}"

response = http.request(request)
puts response.read_body

{
  "path": "<string>",
  "content": "<string>",
  "updated_at": "<string>",
  "file_id": "<string>",
  "version": 2,
  "entity_type": "page",
  "_links": {}
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

PUT

projects

{project_reference}

branches

{branchName}

files

{filePath}

draft

Replace pending file draft

curl --request PUT \
  --url https://api.veryfront.com/projects/{project_reference}/branches/{branchName}/files/{filePath}/draft \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": "<string>",
  "expected_draft_version": 1073741823
}
'

import requests

url = "https://api.veryfront.com/projects/{project_reference}/branches/{branchName}/files/{filePath}/draft"

payload = {
    "content": "<string>",
    "expected_draft_version": 1073741823
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({content: '<string>', expected_draft_version: 1073741823})
};

fetch('https://api.veryfront.com/projects/{project_reference}/branches/{branchName}/files/{filePath}/draft', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.veryfront.com/projects/{project_reference}/branches/{branchName}/files/{filePath}/draft",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'content' => '<string>',
    'expected_draft_version' => 1073741823
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.veryfront.com/projects/{project_reference}/branches/{branchName}/files/{filePath}/draft"

	payload := strings.NewReader("{\n  \"content\": \"<string>\",\n  \"expected_draft_version\": 1073741823\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.veryfront.com/projects/{project_reference}/branches/{branchName}/files/{filePath}/draft")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"content\": \"<string>\",\n  \"expected_draft_version\": 1073741823\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.veryfront.com/projects/{project_reference}/branches/{branchName}/files/{filePath}/draft")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"content\": \"<string>\",\n  \"expected_draft_version\": 1073741823\n}"

response = http.request(request)
puts response.read_body

{
  "path": "<string>",
  "content": "<string>",
  "updated_at": "<string>",
  "file_id": "<string>",
  "version": 2,
  "entity_type": "page",
  "_links": {}
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

Authorizations

Authorization

string

header

required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

project_reference

string

required

Project slug, UUID, or domain that identifies the project.

branchName

string

required

Branch name

filePath

string

required

File path (URL-encoded, for example, pages%2Findex.mdx).

Body

application/json

content

string

required

Full pending source-file body; empty strings are valid. Saves durable Yjs repair without creating an immutable version. Identical bodies retain the pending draft sequence.

expected_draft_version

integer | null

Observed pending draft sequence; zero means no prior draft. Separate from commit expected-version IDs. Omit for unconditional replacement; a stale sequence returns 409.

Required range: 0 <= x <= 2147483647

Response

Persisted pending draft

path

string

required

Path of the source file.

content

string

required

Full pending draft body, including empty bodies. A draft without a readable full snapshot is not found.

updated_at

string

required

When the pending draft was last saved.

file_id

string

Id of the source file whose draft was replaced.

version

integer

Current pending draft sequence; resets after commit/discard. Use as expected_draft_version for a guarded draft write.

Required range: x >= 1

entity_type

enum<string>

Canonical source-file type.

Available options:

page,

component,

function,

virtual_file

_links

object

Hypermedia links to the draft and its file.

Show child attributes

Get started

APIs

REST API

GraphQL API

MCP API

Replace pending file draft

Authorizations

Path Parameters

Body

Response