Skip to main content
POST
Discard an assignment set

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

setId
string<uuid>
required

Assignment set identifier.

Body

application/json
reason
enum<string>
required

Why the composition was called off. abandoned: nobody is going to finish it. member_ineligible: a line in it can never be sold and was holding every other line with it. counterparty_declined: the fund or its administrator walked away outside the remessa. superseded: replaced by another composition. Required — free text is a disposition nobody can count.

Available options:
abandoned,
member_ineligible,
counterparty_declined,
superseded
note
string

The particulars, in the operator's own words. Optional; omitted rather than blanked on the audit row when there is nothing to add.

Maximum string length: 512

Response

OK

fromState
string
required

Where the set stood when the decision landed, or the state it was already in on a replay.

replayed
boolean
required

True when this set was ALREADY discarded and nothing was written. No second audit row was appended and no second decision was recorded.

setId
string
required

The composition that was called off.

state
string
required

Always cancelled: the terminal state a discarded composition rests in. Nothing is deleted — the items, the transitions, the approval and the custodied evidence all stand.