Skip to main content
POST
Test Workflow

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json
jobId
string | null

Job ID to build the workflow context from. Provide jobId or orderId (or both).

Minimum string length: 1
orderId
string | null

Order ID to build the workflow context from. Provide jobId or orderId (or both).

Minimum string length: 1
live
boolean
default:false

When false (default) the run is a dry run: filters are evaluated against the real entity and every action returns a preview of what it would do without performing it. When true, only the messaging actions (send_slack, send_email, send_sms) are performed, with their content prefixed by [Test]; all other actions remain preview-only.

Response

422 - application/json

Unprocessable Content

error
NashErrorDetails · object
required
response_status
string
required
RequestID
string
required