Skip to main content
POST
Start a journey run from a previewed plan (idempotent)

Authorizations

Authorization
string
header
required

A cdojo_... API key created in the app under Settings.

Headers

Idempotency-Key
string

A retry key for this start. Reusing it with the same body returns the original run; reusing it with a different body answers 409.

Required string length: 1 - 128

Body

application/json

Send an Idempotency-Key header with it. A retry carrying the same key returns the original run instead of starting a second one.

planId
string
required
planHash
string
required

From the preview response. A mismatch answers 409 rather than running a plan you did not review.

Response

Accepted; the run is active work.

success
boolean
required
data
object
required
meta
object

Paging, on the operations that return a list.