Skip to main content
PATCH
Update background job

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_.

Path Parameters

id
string<uuid>
required

Background job ID.

Body

application/json

Any subset of the job's config. Validated server-side.

name
string
description
string
cron_expression
string
lead_filters
object[]
steps
object[]

1-3 steps run on each candidate lead. Each step is one of: (1) {type:'evaluate_metadata'|'evaluate_field', conditions:[{field, operator, format?, value?}], on_match, on_no_match} — evaluate a lead.metadata key (evaluate_metadata) or a collected funnel field/variable (evaluate_field); operator: date_before_today | date_after_today (need format 'DD/MM/YYYY'|'YYYY-MM-DD'|'MM/DD/YYYY') | equals | not_equals | greater_than | less_than | exists | not_exists. (2) {type:'evaluate_tag', conditions:[{type:'date_in_tag', match_value, date_format, trigger_when:'future'|'past'}], on_match, on_no_match}. (3) {type:'action', action:} — run an action for every candidate (no condition). An is one of: {type:'send_message', channel:'whatsapp', template_name, then_status_key?} — sends an APPROVED WhatsApp template; its variables (incl. a dynamic {{link}}) resolve via the workflow's template_var_tools; then_status_key moves the lead to that status after sending (use it for 'send exactly once'); {type:'set_lead_status', status_key}; {type:'assign_workflow', workflow_id}; {type:'workflow_transfer', target_workflow_id}; {type:'enrich_lead', ...}.

max_leads_per_cycle
integer
cooldown_minutes
integer
dry_run
boolean
is_active
boolean

Response

Background job updated

data
object
Last modified on June 30, 2026