---
title: "Update sheet_upload by ID"
method: PATCH
path: "/api/v3/projects/{project_id}/sheet_uploads/{id}"
tags: ["sheet uploads"]
---

# Update sheet_upload by ID

`PATCH /api/v3/projects/{project_id}/sheet_uploads/{id}`

## Path parameters

- `project_id` string, uuid, required
- `id` string, uuid, required

## Headers

- `Fieldwire-Version` string, date, required

## Request body

- SheetUploadUpdateInput — Schema for updating sheet uploads
  - `is_processed` boolean — Whether this upload was successfully processed into plan(s)
  - `version_description` string, nullable — Description for the uploaded file
  - `version_notes` string, nullable — Notes for the uploaded file
  - `last_editor_user_id` integer, nullable — ID of the user making this update (required when authenticating via API key)

## Response `201`

Successful response

- SheetUpload — Entity that denotes an uploaded file which gets processed into plan(s)
  - `id` string, uuid, required — ID of the entity
  - `user_id` integer, required — ID of the user who uploaded this
  - `folder_id` string, uuid, nullable — ID of the folder this was uploaded into
  - `project_id` string, uuid, required — ID of the project this entity belongs to
  - `active_sheets_count` integer, nullable — Number of active Sheets in the Project, returned when query param count_active_sheets is set to true.
  - `status` 'errored' | 'processed' | 'queued' | 'processing' | 'uploading' | 'splitting', nullable — Status of the Sheet upload in the project.
  - `has_errors` boolean, required — Whether any errors were hit while processing this upload
  - `is_processed` boolean, required — Whether this upload was successfully processed into plan(s)
  - `file_size` string, nullable — Size in bytes of the uploaded file
  - `file_url` string, nullable — URL of the file uploaded
  - `name` string, required — Name of the entity
  - `version_description` string, nullable — Description for the uploaded file
  - `pages` integer, nullable — Count of pages in the uploaded file
  - `pages_split` integer, nullable — Count of pages so far this has been split into (useful to show the state of processing)
  - `pages_uploaded` integer, nullable — Count of split pages so far that have been uploaded (useful to show the state of processing)
  - `plans_created` integer, nullable — Count of plans created out of this upload
  - `version_notes` string, nullable — Notes for the uploaded file
  - `created_at` string, date-time, required — Time when the server created the entity
  - `updated_at` string, date-time, required — Time when the server last updated the entity

---

[API](https://skmtc.net/fieldwire/apis/fieldwire-super-api.md) · [All operations](https://skmtc.net/fieldwire/apis/fieldwire-super-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fieldwire/fieldwire-super-api/versions/66ee1c20b92d/schema)