Skip to main content
POST
Run a Scheduled Function Now
Safety and behavior notes
  • A caller-supplied ctx object bypasses a fresh lead, agent, or host lookup.
  • Direct REST has no confirmation gate. Sending confirm=false does not prevent execution because confirm is ignored.
  • The function executes immediately and applies buffered effects to real tenant data. A ctx override bypasses normal cohort lookup.
  • It runs only the published version, never a pending draft. If that version cannot be deployed, it returns HTTP 503 and runs nothing.
This is a real execution of the published version. To try a draft without applying lead changes or sending writes, use Test. Before calling it on behalf of an operator, show how many leads it will touch with Preview cohort and get their confirmation.

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_.

Path Parameters

id
string<uuid>
required

Scheduled Function id.

Body

application/json
ctx
object

Optional full context override. When present as an object, normal lead/agent/host lookup is bypassed.

Response

Successful response.

effects_may_apply
any
required
Available options:
true
run
object
required
deploy_error
string | null
required
success
any
required

Observed top-level response field.

Last modified on October 6, 2026