Skip to main content
PATCH
Patch diagnostics/routing/admin fields

Authorizations

Authorization
string
header
required

Client credentials, the production model: server-to-server, short-lived tokens, least-privilege scopes, rotation by issuing a new client secret.

Path Parameters

intent_id
string
required

The Intent ID minted by POST /intent. Minted at the decision and carried unchanged into every destination record. Fits a 64-character client-supplied id field, which is how the same id finds the record in either direction.

Pattern: ^[A-Za-z0-9_-]{10,64}$
Example:

"itn_7f3aK2mQ9xLp"

Body

application/json

Merge payload fields, or set a patchable top-level field. A patch bumps intent_version: a changed intent is a new publishable version by design.

payload
object
defence_file_ref
string<uri>

Reference to the Compliance File (the field keeps its original name until a versioned schema rename).

Response

OK

Canonical system-of-engagement record keyed by intent_id.

intent_id
string
required

Identifier-safe ID minted by composerID. URI-safe, no special characters.

Pattern: ^[A-Za-z0-9_-]{10,64}$
intent_version
integer
required

Monotonically increasing version; a bump mints a new idempotency key.

Required range: x >= 1
state
enum<string>
required

Lifecycle state. Transitions enforce minimum-viable guards.

Available options:
draft,
diagnosed,
decided,
planned,
published,
failed,
cancelled
created_at
string<date-time>
required

ISO 8601 timestamp of intent creation.

payload
object

Opaque intent payload — diagnostic answers, routing, admin fields. Structure depends on the Triage questionnaire; composerID does not interpret it.

publishing
PublishingBundle · object

Populated after the first successful publish.

defence_file_ref
string<uri>

URI to the DefenceFile (JSON-LD) evidence artifact.

override_event
object | null

Present when a human override bypassed standard diagnostic scoring.

updated_at
string<date-time>