Workbench

Quote Workbench Unlock

Price an unlock. CHARGES NOTHING, and unlocks nothing.

Returns the exact locked-row count for the scope, the organisation's live balance, and the shortfall if there is one. It also returns the operation_id that unlock-rows REQUIRES - so this call is not optional advice, it is step one of the handshake.

Send this exact body to unlock-rows afterwards: the quote prices the scope the unlock will charge for, and a different body is a different price.

post/workbench/tables/{table_id}/unlock-quote

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/workbench/tables/{table_id}/unlock-quote
  • Auth: HTTP bearer

Path parameters

table_idstring required

Workbench table id (UUID).

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

row_idsinteger[] nullable

Rows to act on. OMIT to mean EVERY locked row in the table.

exclude_row_idsinteger[] nullable

Rows to leave locked.

approved_max_creditsinteger nullable

Ceiling the caller approves. The run refuses to exceed it.

quote_expires_atstring date-time nullable

Expiry of the quote being approved.

operation_idstring uuid nullable

The quote's operation id. REQUIRED by the unlock - it is what ties the charge to a price the caller was shown, and it makes a retried unlock idempotent instead of charging twice.

Response

Successful Response

dataEnrichmentPayload required

One enrichment object, open-shaped.

Open on purpose: a workbench column set is defined by the CUSTOMER at runtime, and the enrichment result shapes grow with every provider added. Pinning them would drop whatever a provider returned that this contract had not caught up on, which on an enrichment surface is the data the customer paid for.

Changes

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