Skip to content

Update extraction cells

PATCH
/api/Extractions/cells
curl --request PATCH \
--url https://app.docstosheets.com/api/Extractions/cells \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "rowOperations": [ { "extractionId": "example", "op": "add", "section": "example", "index": 1 } ], "changes": [ { "extractionId": "example", "fieldPath": "example", "newValue": "example" } ] }'

Batch-updates cell values across extractions in a mailbox.

mailboxId
string

The mailbox ID (partition key).

The batch update request.

Media type application/json

Request to update cell values in extractions (batch update). Row operations are applied before cell changes.

object
rowOperations

Section row additions/removals to apply (before cell changes).

Array<object>

Adds or removes a row within a repeating section of an extraction.

object
extractionId

The extraction ID to update.

string
op
One of:
string
Allowed values: add remove
section

The section (group id) the row belongs to.

string
index

For remove: the row index to delete. For add: optional insert position (defaults to append).

integer format: int32
nullable
changes

List of cell changes to apply.

Array<object>

A single cell change in an extraction.

object
extractionId

The extraction ID to update.

string
fieldPath

The field path to update: “Data.{key}” for header values or “Sections.{groupId}[{index}].data.{key}” for section rows.

string
newValue

The new value for the field.

nullable

Summary of updates applied.

Media type application/json

Result of a batch update operation.

object
successCount

Number of extractions successfully updated.

integer format: int32
failedUpdates

List of failed updates with error details.

Array<object>

Details about a failed update.

object
extractionId

The extraction ID that failed to update.

string
error

Error message describing the failure.

string
Example generated
{
"successCount": 1,
"failedUpdates": [
{
"extractionId": "example",
"error": "example"
}
]
}
Media type application/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
nullable
Example generated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}
Media type application/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
nullable
Example generated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}