Skip to main content
PATCH
Update a Scheduled Function
Safety and behavior notes
  • HTTP 200 can include deploy_error.
  • Code changes or reactivation deploy, while cron or timezone changes recalculate next_run_at. An empty body still updates updated_at.
  • Most property types are not strictly validated, and is_active is coerced by truthiness.
  • A body with only unknown fields, or an empty body, returns HTTP 200 instead of HTTP 400.

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
name
string
description
string
code
string
cron_expression
string
timezone
string
is_active
boolean
lookup_config
object
max_leads_per_cycle
integer
Required range: 1 <= x <= 500

Response

Successful response.

function
object
required
deploy_error
string | null
required
success
any
required

Observed top-level response field.

Last modified on September 8, 2026