Skip to main content
POST
Create or Update a Host 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
template_name
string
required

Nonblank; stored without trimming.

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

Any finite number at the handler; DB integer can reject fractions.

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

Defaults true; no handler type validation.

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