Skip to main content
POST
Create or Update a Lead Reminder Rule

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_.

Body

application/json
trigger_event
enum<string>
required
Available options:
event_created,
event_cancelled,
call_analyzed,
event_enrolled,
event_ended
template_name
string
required

Must contain at least one non-whitespace character; stored without trimming.

Minimum string length: 1
workflow_id
string<uuid> | null
channel
enum<string>
default:whatsapp
Available options:
whatsapp,
retell,
sms,
email
delay_minutes
number
default:0

Handler accepts any finite number; database column is integer, so fractions can fail as 500.

delay_reference
enum<string>
default:trigger
Available options:
trigger,
event_start,
event_start_local,
event_end,
contact_schedule_start
is_active
any

Defaults true. Type is not validated before PostgreSQL boolean coercion.

name
any

Defaults null. Type/length are not validated before PostgreSQL text coercion.

Response

Existing natural-key rule updated.

success
enum<boolean>
required
Available options:
true
rule
object
required
status
enum<string>
required
Available options:
updated
template_status
string
channel_availability
object
warning
string
warnings
string[]
Last modified on September 8, 2026