API ReferenceUnderstand Coverage

Create a pathway draft

View as MarkdownOpen in Claude

Creates a new pathway draft owned by the operator’s organisation. Drafts are unpublished pathways in development; only one draft per organisation may exist at a time. Submit the empty draft and edit the tree via update, or include an initial decisionTree if your tooling is set up to author it. Returns the new identifier and the draft status acknowledgement.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
namestringRequired

Machine-readable name for the pathway. Used in URLs and analytics.

versionstringRequired
Semantic version assigned by the pathway authors.
titlestringRequired

Human-readable title for the pathway.

descriptionstringOptional

Free-text description of the pathway’s purpose and scope.

decisionTreemap from strings to anyOptional

Initial decision-tree structure. Pathway authors typically create the draft empty and edit the tree via update; the field is documented here so existing tooling that submits a tree on create remains supported. Decision tree shape is internal and may evolve; consumers should treat it as opaque JSON and use the dedicated pathway-execution endpoints to traverse it.

Response

The newly-created draft.

dataobject
messagestring

Human-readable acknowledgement.