Skip to main content
POST
Create a Scheduled Function
Safety and behavior notes
  • HTTP 201 does not guarantee deployment; inspect deploy_error.
  • The row is created, the next run is calculated, and deployment is attempted. Start inactive when effects are risky.
  • Most request property types are not strictly validated before persistence and deployment.

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_.

Body

application/json
name
string
default:Untitled job
description
string
default:""
code
string
default:Built-in starter source
cron_expression
string
default:0 9 * * *
timezone
string
default:UTC

IANA timezone accepted by cron-parser.

is_active
boolean
default:true
lookup_config
object
max_leads_per_cycle
integer
default:50
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