Skip to content

Set Workbench Schedule

PUT
/workbench/tables/{table_id}/schedule

Run something on this table on a schedule. CAN ARM ONGOING SPEND.

action_type: run_ai means every firing runs the table’s AI passes and charges for them - nightly, forever, with nobody in the loop. run_formula is local and free; crm_import reaches the customer’s CRM.

enabled defaults to FALSE, so writing a schedule and starting it are two separate acts. That is deliberate: it lets a caller define the cadence, read it back, and only then turn it on.

Authorizations

Parameters

Path Parameters

table_id
required

Workbench table id (UUID).

string

Workbench table id (UUID).

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Run something on this table on a schedule.

A schedule whose action_type is run_ai SPENDS CREDITS on every firing, without a further call. enabled defaults to false so creating one is not the same act as starting it.

object
action_config
Any of:
object
key
additional properties
any
action_type
required
string
Allowed values: run_ai run_formula crm_import
cron_expression
Any of:
string
>= 5 characters <= 100 characters
enabled
boolean
frequency
Any of:
string
Allowed values: hourly daily weekly

Responses

200

Successful Response

object
data
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.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string