---
title: "Partial update suggested edit"
method: PATCH
path: "/api/v1/suggested_edits/{suggestedEditID}"
tags: ["Suggested Edit"]
---

# Partial update suggested edit

`PATCH /api/v1/suggested_edits/{suggestedEditID}`

Update part of suggested edit object.

## Path parameters

- `suggestedEditID` integer, required

## Request body

- SuggestedEditBase
  - `id` integer — ID of the suggested edit.
  - `url` string, url — URL of the suggested edit.
  - `annotation` string, url — Annotation that suggested edit is related to.
  - `documents` DocumentSplitDescriptor[] — List of document split descriptors.
    - `pages` PageDescriptor[] — List of pages that should be split.
      - `page` string, url — Page to split.
      - `rotation` integer — Rotation of the page.
      - `deleted` boolean — Indicates whether the page is marked as deleted.
    - `target_queue` string, url — Target queue for the suggested split.
    - `values` object — Edit values to be propagated to newly created annotations. Keys must be prefixed with "edit:", e.g. "edit:document_type". Schema Datapoint description describes how it is used to initialize datapoint value.

## Response `200`

OK

- SuggestedEdit
  - `id` integer, required — ID of the suggested edit.
  - `url` string, url, required — URL of the suggested edit.
  - `annotation` string, url, required — Annotation that suggested edit is related to.
  - `documents` DocumentSplitDescriptor[], required — List of document split descriptors.
    - `pages` PageDescriptor[] — List of pages that should be split.
      - `page` string, url — Page to split.
      - `rotation` integer — Rotation of the page.
      - `deleted` boolean — Indicates whether the page is marked as deleted.
    - `target_queue` string, url — Target queue for the suggested split.
    - `values` object — Edit values to be propagated to newly created annotations. Keys must be prefixed with "edit:", e.g. "edit:document_type". Schema Datapoint description describes how it is used to initialize datapoint value.

## Other responses

- `400` — Invalid input data.
- `401` — The username/password is invalid or token is invalid (e.g. expired).
- `403` — Insufficient permission, missing authentication, invalid CSRF token and similar issue.
- `404` — The specified resource was not found.
- `409` — Conflict
- `413` — Payload too large (especially for files uploaded).
- `429` — Request rate is too high, wait before sending more requests. See [Rate Limiting](/guides/overview#rate-limiting) for more details.
- `500` — Server failure while processing the request.
- `502` — Invalid response from the upstream server.
- `503` — We're temporarily offline for maintenance. Please try again later.
- `504` — Upstream server could not complete the request in time.

---

[API](https://skmtc.dev/rossum/apis/rossum-api.md) · [All operations](https://skmtc.dev/rossum/apis/rossum-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/rossum/rossum-api/revisions/f1b5a910991d/schema)