Skip to content
OpenGTM

Run Workbook

POST
/api/workbooks/{workbook_id}/run
curl --request POST \
  --url http://localhost:8000/api/workbooks/example/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "column_ids": [ "example" ], "fill_missing": false, "force": false, "lead_ids": [ 1 ], "row_ids": [ 1 ] }'

Run enrichment on workbook rows (v2: WorkbookRow, v1 fallback: leads DB).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workbook_id
required
Workbook Id
string

Header Parameters

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

Request Body

Section titled “Request Body”
Media typeapplication/json
RunWorkbookRequest

Request to run enrichment on a workbook.

object
column_ids
Any of:
Array<string>
fill_missing
Fill Missing

Only enrich cells not already complete — fills gaps, preserves good values

boolean
force
Force

Force re-run: bypass success-skip gates. For output columns this overrides run-once and RE-PUSHES to the destination — the UI must confirm first

boolean
lead_ids
Any of:
Array<integer>
row_ids
Any of:
Array<integer>

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
RunWorkbookResponse

Response after starting a workbook run.

object
message
Message
string
""
status
Status
string
default: started
total_jobs
Total Jobs
integer
0
Example
{
  "message": "",
  "status": "started",
  "total_jobs": 0
}

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