Skip to main content
POST
Create background job

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_.

Body

application/json
name
string
required
steps
object[]
required
Required array length: 1 - 3 elements
description
string
trigger_type
enum<string>
default:cron
Available options:
cron,
event,
api
cron_expression
string

Required for trigger_type=cron, e.g. "0 9 * * *".

filter_mode
enum<string>
Available options:
lead_scoped,
workflow_scoped
lead_filters
object[]
workflow_filters
any

Target leads in given workflow(s)/status(es), e.g. [{workflow_id, status_keys:[...]}].

max_leads_per_cycle
integer

1-500. Defaults to 50.

cooldown_minutes
integer
dry_run
boolean
is_active
boolean

Response

Background job created

data
object
Last modified on June 30, 2026