Skip to content
OpenGTM

Bulk Update Row Data

PATCH
/api/workbooks/{workbook_id}/rows
curl --request PATCH \
  --url 'http://localhost:8000/api/workbooks/example/rows?recompute=true' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "updates": [ { "fields": {}, "row_id": 1 } ] }'

Atomically update up to 1,000 workbook rows for spreadsheet-style paste.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workbook_id
required
Workbook Id
string

Query Parameters

Section titled “Query Parameters”
recompute
Recompute
boolean
default: true

Header Parameters

Section titled “Header Parameters”
x-workspace-id
Any of:
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
BulkUpdateRowsRequest

Bounded spreadsheet paste/update request.

object
updates
required
Updates
Array<object>
>= 1 items <= 1000 items
WorkbookRowUpdate

Editable values for one workbook row in an atomic bulk update.

object
fields
required
Fields
object
>= 1 properties
key
additional properties
any
row_id
required
Row Id
integer
Examplegenerated
{
  "updates": [
    {
      "fields": {},
      "row_id": 1
    }
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Examplegenerated
example

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}