Skip to main content
POST
Create or Update a Recontact Rule

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_.

Body

application/json
name
any
required

Required truthy value; type and length are not validated before the text column.

stale_after_hours
number
required

Required finite number; no positive/range check, and fractions can fail the integer column.

workflow_id
string<uuid> | null
trigger_status_key
any | null

No existence check; any non-cadence key can be stored.

stale_reference
enum<string>
default:last_message_at
Available options:
last_message_at,
last_response_at,
last_touchpoint_at,
status_changed_at,
started_at
cooldown_hours
number
default:24

Finite values accepted without range check; otherwise defaults.

max_attempts
number
default:5

Finite values accepted without range check; otherwise defaults.

on_exhausted
enum<string>
default:mark_cold
Available options:
mark_cold,
pause_run,
nothing
priority
number
default:5

DB enforces 1..10; handler only requires finite when supplied.

Required range: 1 <= x <= 10
prompt_hint
any | null

No handler type/length validation before text coercion.

conditions
any

Defaults to {}. Any JSON value is accepted by the handler and stored as jsonb.

is_active
any

Defaults true; no handler type validation before boolean coercion.

Response

Existing natural-key rule updated.

success
enum<boolean>
required
Available options:
true
rule
object
required
status
enum<string>
required
Available options:
updated
Last modified on September 8, 2026