Contacts

Run Record Workflow

Run a list workflow over rows. SPENDS CREDITS when its steps enrich or call a model.

run_mode=all runs over every row in the list, so the spend is bounded by the list, not the request.

post/contacts/workflow-executions/run

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/contacts/workflow-executions/run
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

list_idinteger required

List (workbench) the workflow belongs to.

workflow_idstring required

Workflow to run.

record_idsinteger[] required

Rows to run it on, for selected.

run_mode'selected' | 'filtered' | 'all'

Which rows to run on.

Response

Successful Response

dataCrmRecordPayload required

An open envelope for one record, one dashboard or one job receipt.

Open because most of these reads are COMPUTED shapes - an engagement summary, a next-best-step, an intelligence status - that grow with the product, and dropping a field from an advisory read makes it say "nothing to report" rather than "we did not tell you".

Changes

No recorded changes to this operation across all 2 revisions of this API.