Skip to content
OpenGTM

Ingest Rows

POST
/api/v2/workbooks/{workbook_id}/rows/ingest
curl --request POST \
  --url http://localhost:8000/api/v2/workbooks/example/rows/ingest \
  --header 'Content-Type: application/json' \
  --data '{ "dedupe": true, "rows": [ {} ] }'

Push rows into a workbook (session/JWT or per-workbook ingest token).

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workbook_id
required
Workbook Id
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
IngestRowsRequest
object
dedupe
Dedupe

Skip rows whose identity (domain/company) already exists or repeats

boolean
default: true
rows
required
Rows

Row dicts keyed by workbook column name or lead field

Array<object>
>= 1 items
object
key
additional properties
any

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"
    }
  ]
}