Skip to main content
PATCH
Set an Agent Opening Message

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_.

Path Parameters

id
string<uuid>
required

Workflow identifier.

Body

application/json
channel
enum<string>
required
Available options:
call
message
string
required
Maximum string length: 1000
agent_speaks_first
boolean
silence_ms
integer
Required range: 1000 <= x <= 30000

Response

Successful response.

success
enum<boolean>
required
Available options:
true
workflow_id
string<uuid>
required
channel
enum<string>
required
Available options:
call,
email,
webchat,
sms,
messenger
opening
object | null
required
Last modified on September 8, 2026