Skip to main content
PATCH
Correct, review or control sharing of a Canvas

Authorizations

Authorization
string
header
required

API key authentication. Pass your key as a Bearer token. Keys use the format hm_live_<32 hex chars>. Generate keys from your Harmonica dashboard settings.

Path Parameters

instanceId
string
required

Existing BMC chain instance ID; each chain has its own Canvas.

Minimum string length: 1

Body

application/json
expectedRevision
integer
required

Latest management.expectedRevision from a read. A stale value returns 409; zero permits a sharing-only change before any Canvas exists.

Required range: x >= 0
edits
object[]
required
Maximum array length: 500
additions
object[]
Maximum array length: 100
removeEntryIds
string[]
Maximum array length: 500

Opaque identity; knowing an ID does not grant access.

Required string length: 1 - 200
approve
boolean

Mark the resulting revision reviewed for the next dependent round; does not establish participant agreement or market validation.

closing
boolean

Requires approve=true, a completed chain and current final extraction; makes the resulting revision the approved closing Canvas.

participantSharingEnabled
boolean

Controls participant Canvas reads, including closing access. Send edits=[] for a sharing-only change, without generating a model revision or model call.

Response

Updated management state and preparation/review eligibility.

state
object | null
required

Null when current source changes withhold the saved Canvas; management and readiness remain available for recovery.

canEdit
boolean
required
canApproveClosing
boolean
required

True only when an editor may approve the current closing Canvas after a completed chain and current final extraction.

sourceStatus
enum<string>
required
Available options:
current,
changed
management
object
required
preparation
object[]
required

Per-round management status; empty for participant projections.

boundSnapshotHeld
boolean
required

A bound review snapshot has a changed source. Preparing a replacement does not replace that immutable binding; restart in a fresh chain to continue the affected round.

boundSnapshotMessage
string | null
required