Skip to main content
PATCH
Configure a Status Timeout Rule

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_.

Body

application/json
workflow_id
string<uuid>
required
status_key
string
required
Minimum string length: 1
clear
any

Any truthy JSON value clears, including the string "false". Falsy or omitted values enter set mode.

timeout
number

In set mode, must be finite; no positive/integer/range check.

unit
any

In set mode, must be truthy; no enum/type validation.

target_status_key
any

In set mode, must be truthy and name an existing status in the same workflow.

Response

Timeout set or cleared; clear returns status.timeout_config as null.

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